summaryrefslogtreecommitdiff
path: root/data/zh_cn/aimiaobi
diff options
context:
space:
mode:
Diffstat (limited to 'data/zh_cn/aimiaobi')
-rw-r--r--data/zh_cn/aimiaobi/2023-08-01/api-docs.php61742
1 files changed, 22373 insertions, 39369 deletions
diff --git a/data/zh_cn/aimiaobi/2023-08-01/api-docs.php b/data/zh_cn/aimiaobi/2023-08-01/api-docs.php
index 85df24c..ff8efb7 100644
--- a/data/zh_cn/aimiaobi/2023-08-01/api-docs.php
+++ b/data/zh_cn/aimiaobi/2023-08-01/api-docs.php
@@ -1,452 +1,216 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'RPC',
- 'product' => 'AiMiaoBi',
- 'version' => '2023-08-01',
- ],
+ 'info' => ['style' => 'RPC', 'product' => 'AiMiaoBi', 'version' => '2023-08-01'],
'directories' => [
[
- 'id' => 403374,
- 'title' => '通用接口',
+ 'children' => ['CreateToken', 'ListDialogues', 'ListVersions', 'GetProperties'],
'type' => 'directory',
- 'children' => [
- 'CreateToken',
- 'ListDialogues',
- 'ListVersions',
- 'GetProperties',
- ],
+ 'title' => '通用接口',
+ 'id' => 446752,
],
[
- 'id' => 403379,
- 'title' => '通用接口-文件上传下载',
+ 'children' => ['GenerateFileUrlByKey', 'GenerateUploadConfig'],
'type' => 'directory',
- 'children' => [
- 'GenerateFileUrlByKey',
- 'GenerateUploadConfig',
- ],
+ 'title' => '通用接口-文件上传下载',
+ 'id' => 446753,
],
[
- 'id' => 403382,
- 'title' => '通用接口-异步任务管理',
+ 'children' => ['SubmitAsyncTask', 'CancelAsyncTask', 'QueryAsyncTask', 'ListAsyncTasks'],
'type' => 'directory',
- 'children' => [
- 'SubmitAsyncTask',
- 'CancelAsyncTask',
- 'QueryAsyncTask',
- 'ListAsyncTasks',
- ],
+ 'title' => '通用接口-异步任务管理',
+ 'id' => 446754,
],
[
- 'id' => 403387,
- 'title' => '通用接口-通用配置',
+ 'children' => ['CreateGeneralConfig', 'ListGeneralConfigs', 'GetGeneralConfig', 'UpdateGeneralConfig', 'DeleteGeneralConfig'],
'type' => 'directory',
- 'children' => [
- 'CreateGeneralConfig',
- 'ListGeneralConfigs',
- 'GetGeneralConfig',
- 'UpdateGeneralConfig',
- 'DeleteGeneralConfig',
- ],
+ 'title' => '通用接口-通用配置',
+ 'id' => 446755,
],
[
- 'id' => 403393,
- 'title' => '妙笔-创作文章',
+ 'children' => ['RunAiHelperWriting', 'RunWritingV2', 'RunWriting', 'RunStepByStepWriting', 'RunTranslateGeneration', 'RunTextPolishing', 'RunKeywordsExtractionGeneration', 'RunContinueContent', 'RunWriteToneGeneration', 'RunTitleGeneration', 'RunSummaryGenerate', 'RunExpandContent', 'RunAbbreviationContent', 'SearchNews', 'RunQuickWriting', 'ListBuildConfigs', 'GenerateImageTask', 'FetchImageTask', 'FeedbackDialogue'],
'type' => 'directory',
- 'children' => [
- 'RunAiHelperWriting',
- 'RunWritingV2',
- 'RunWriting',
- 'RunStepByStepWriting',
- 'RunTranslateGeneration',
- 'RunTextPolishing',
- 'RunKeywordsExtractionGeneration',
- 'RunContinueContent',
- 'RunWriteToneGeneration',
- 'RunTitleGeneration',
- 'RunSummaryGenerate',
- 'RunExpandContent',
- 'RunAbbreviationContent',
- 'SearchNews',
- 'RunQuickWriting',
- 'ListBuildConfigs',
- 'GenerateImageTask',
- 'FetchImageTask',
- 'FeedbackDialogue',
- ],
+ 'title' => '妙笔-创作文章',
+ 'id' => 446756,
],
[
- 'id' => 403413,
+ 'children' => ['ListStyleLearningResult', 'RunStyleFeatureAnalysis', 'SaveStyleLearningResult', 'DeleteStyleLearningResult', 'GetStyleLearningResult', 'ListWritingStyles'],
+ 'type' => 'directory',
'title' => '妙笔-文体仿写',
+ 'id' => 446757,
+ ],
+ [
+ 'children' => ['SubmitVideoAudit', 'QueryVideoAuditResult'],
'type' => 'directory',
- 'children' => [
- 'ListStyleLearningResult',
- 'RunStyleFeatureAnalysis',
- 'SaveStyleLearningResult',
- 'DeleteStyleLearningResult',
- 'GetStyleLearningResult',
- 'ListWritingStyles',
- ],
+ 'title' => '妙笔-视频审校',
+ 'id' => 446758,
],
[
- 'id' => 403420,
- 'title' => '妙笔-文章审校-规则库管理',
+ 'children' => ['SubmitAuditNote', 'ConfirmAndPostProcessAuditNote', 'DownloadAuditNote', 'DeleteAuditNote', 'GetAuditNotePostProcessingStatus', 'GetAuditNoteProcessingStatus', 'GetAvailableAuditNotes'],
'type' => 'directory',
- 'children' => [
- 'SubmitAuditNote',
- 'ConfirmAndPostProcessAuditNote',
- 'DownloadAuditNote',
- 'DeleteAuditNote',
- 'GetAuditNotePostProcessingStatus',
- 'GetAuditNoteProcessingStatus',
- 'GetAvailableAuditNotes',
- ],
+ 'title' => '妙笔-文章审校-规则库管理',
+ 'id' => 446759,
],
[
- 'id' => 403428,
- 'title' => '妙笔-文章审校-词库管理',
+ 'children' => ['ListAuditTerms', 'AddAuditTerms', 'EditAuditTerms', 'DeleteAuditTerms', 'SubmitImportTermsTask', 'FetchImportTermsTask', 'SubmitExportTermsTask', 'FetchExportTermsTask'],
'type' => 'directory',
- 'children' => [
- 'ListAuditTerms',
- 'AddAuditTerms',
- 'EditAuditTerms',
- 'DeleteAuditTerms',
- 'SubmitImportTermsTask',
- 'FetchImportTermsTask',
- 'SubmitExportTermsTask',
- 'FetchExportTermsTask',
- ],
+ 'title' => '妙笔-文章审校-词库管理',
+ 'id' => 446760,
],
[
- 'id' => 403437,
- 'title' => '妙笔-文章审校-事实性审核',
+ 'children' => ['SubmitFactAuditUrl', 'GetFactAuditUrl', 'DeleteFactAuditUrl'],
'type' => 'directory',
- 'children' => [
- 'SubmitFactAuditUrl',
- 'GetFactAuditUrl',
- 'DeleteFactAuditUrl',
- ],
+ 'title' => '妙笔-文章审校-事实性审核',
+ 'id' => 446761,
],
[
- 'id' => 403441,
- 'title' => '妙笔-文章审校',
+ 'children' => ['QueryAuditTask', 'SubmitAuditTask', 'CancelAuditTask', 'SubmitSmartAudit', 'GetSmartAuditResult', 'ListAuditContentErrorTypes', 'ExportAuditContentResult'],
'type' => 'directory',
- 'children' => [
- 'QueryAuditTask',
- 'SubmitAuditTask',
- 'CancelAuditTask',
- 'SubmitSmartAudit',
- 'GetSmartAuditResult',
- 'ListAuditContentErrorTypes',
- 'ExportAuditContentResult',
- ],
+ 'title' => '妙笔-文章审校',
+ 'id' => 446762,
],
[
- 'id' => 403449,
- 'title' => '妙笔-文档管理',
+ 'children' => ['GenerateExportWordTask', 'FetchExportWordTask', 'CreateGeneratedContent', 'DeleteGeneratedContent', 'UpdateGeneratedContent', 'GetGeneratedContent', 'ListGeneratedContents', 'ExportGeneratedContent'],
'type' => 'directory',
- 'children' => [
- 'GenerateExportWordTask',
- 'FetchExportWordTask',
- 'CreateGeneratedContent',
- 'DeleteGeneratedContent',
- 'UpdateGeneratedContent',
- 'GetGeneratedContent',
- 'ListGeneratedContents',
- 'ExportGeneratedContent',
- ],
+ 'title' => '妙笔-文档管理',
+ 'id' => 446763,
],
[
- 'id' => 403458,
- 'title' => '妙笔-素材库',
+ 'children' => ['SaveMaterialDocument', 'DeleteMaterialById', 'UpdateMaterialDocument', 'GetMaterialById', 'ListMaterialDocuments'],
'type' => 'directory',
- 'children' => [
- 'SaveMaterialDocument',
- 'DeleteMaterialById',
- 'UpdateMaterialDocument',
- 'GetMaterialById',
- 'ListMaterialDocuments',
- ],
+ 'title' => '妙笔-素材库',
+ 'id' => 446764,
],
[
- 'id' => 403464,
- 'title' => '妙笔-素材库-自定义文本',
+ 'children' => ['GetCustomText', 'UpdateCustomText', 'ListCustomText', 'SaveCustomText', 'DeleteCustomText', 'DocumentExtraction'],
'type' => 'directory',
- 'children' => [
- 'GetCustomText',
- 'UpdateCustomText',
- 'ListCustomText',
- 'SaveCustomText',
- 'DeleteCustomText',
- 'DocumentExtraction',
- ],
+ 'title' => '妙笔-素材库-自定义文本',
+ 'id' => 446765,
],
[
- 'id' => 403471,
- 'title' => '妙笔-视频混剪',
+ 'children' => ['GetClipsBuildInResource', 'AsyncCreateClipsTimeLine', 'AsyncEditTimeline', 'AsyncUploadVideo', 'GetAutoClipsTaskInfo', 'AsyncCreateClipsTask', 'ListAutoClipsTask'],
'type' => 'directory',
- 'children' => [
- 'GetClipsBuildInResource',
- 'AsyncCreateClipsTimeLine',
- 'AsyncEditTimeline',
- 'AsyncUploadVideo',
- 'GetAutoClipsTaskInfo',
- 'AsyncCreateClipsTask',
- 'ListAutoClipsTask',
- ],
+ 'title' => '妙笔-视频混剪',
+ 'id' => 446766,
],
[
- 'id' => 403479,
- 'title' => '妙策-自定义数据源',
+ 'children' => ['SubmitCustomSourceTopicAnalysis', 'GetCustomSourceTopicAnalysisTask', 'ExportCustomSourceAnalysisTask'],
'type' => 'directory',
- 'children' => [
- 'SubmitCustomSourceTopicAnalysis',
- 'GetCustomSourceTopicAnalysisTask',
- 'ExportCustomSourceAnalysisTask',
- ],
+ 'title' => '妙策-自定义数据源',
+ 'id' => 446767,
],
[
- 'id' => 403483,
- 'title' => '公文库检索',
+ 'children' => ['ListDocumentRetrieve'],
'type' => 'directory',
- 'children' => [
- 'ListDocumentRetrieve',
- ],
+ 'title' => '公文库检索',
+ 'id' => 446768,
],
[
- 'id' => 403485,
- 'title' => '妙策-选题热点',
+ 'children' => ['RunTopicSelectionMerge', 'ListHotNewsWithType', 'ListHotSources', 'ListHotTopics', 'GetTopicById', 'ListHotViewPoints', 'ListTimedViewAttitude', 'ListFreshViewPoints', 'ListWebReviewPoints', 'ListPlanningProposal', 'ExportHotTopicPlanningProposals'],
'type' => 'directory',
- 'children' => [
- 'RunTopicSelectionMerge',
- 'GenerateViewPoint',
- 'ListHotNewsWithType',
- 'ListHotSources',
- 'ListHotTopics',
- 'GetTopicById',
- 'ListHotViewPoints',
- 'ListTimedViewAttitude',
- 'ListFreshViewPoints',
- 'ListWebReviewPoints',
- 'ListPlanningProposal',
- 'ExportHotTopicPlanningProposals',
- ],
+ 'title' => '妙策-选题热点',
+ 'id' => 446769,
],
[
- 'id' => 403498,
- 'title' => '妙策-自定义话题',
+ 'children' => ['DeleteCustomTopicByTopic', 'ListTopicViewPointRecommendEventList', 'ListTopicRecommendEventList', 'RunCustomHotTopicAnalysis', 'RunCustomHotTopicViewPointAnalysis', 'ListCustomViewPoints', 'DeleteCustomTopicViewPointById'],
'type' => 'directory',
- 'children' => [
- 'DeleteCustomTopicByTopic',
- 'ListTopicViewPointRecommendEventList',
- 'ListTopicRecommendEventList',
- 'RunCustomHotTopicAnalysis',
- 'RunCustomHotTopicViewPointAnalysis',
- 'ListCustomViewPoints',
- 'DeleteCustomTopicViewPointById',
- ],
+ 'title' => '妙策-自定义话题',
+ 'id' => 446770,
],
[
- 'id' => 403506,
- 'title' => '妙策-openapi',
+ 'children' => ['SubmitDocClusterTask', 'GetDocClusterTask', 'SubmitTopicSelectionPerspectiveAnalysisTask', 'GetTopicSelectionPerspectiveAnalysisTask', 'SubmitCustomTopicSelectionPerspectiveAnalysisTask', 'GetCustomTopicSelectionPerspectiveAnalysisTask'],
'type' => 'directory',
- 'children' => [
- 'SubmitDocClusterTask',
- 'GetDocClusterTask',
- 'SubmitTopicSelectionPerspectiveAnalysisTask',
- 'GetTopicSelectionPerspectiveAnalysisTask',
- 'SubmitCustomTopicSelectionPerspectiveAnalysisTask',
- 'GetCustomTopicSelectionPerspectiveAnalysisTask',
- ],
+ 'title' => '妙策-openapi',
+ 'id' => 446771,
],
[
- 'id' => 403513,
- 'title' => '妙策-新闻播报',
+ 'children' => ['GetHotTopicBroadcast', 'SubmitCustomHotTopicBroadcastJob', 'GetCustomHotTopicBroadcastJob'],
'type' => 'directory',
- 'children' => [
- 'GetHotTopicBroadcast',
- 'SubmitCustomHotTopicBroadcastJob',
- 'GetCustomHotTopicBroadcastJob',
- ],
+ 'title' => '妙策-新闻播报',
+ 'id' => 446772,
],
[
- 'id' => 403517,
- 'title' => '妙策-企业VOC挖掘',
+ 'children' => ['ExportAnalysisTagDetailByTaskId', 'ValidateUploadTemplate', 'SubmitEnterpriseVocAnalysisTask', 'ListAnalysisTagDetailByTaskId', 'GetEnterpriseVocAnalysisTask', 'GetCategoriesByTaskId'],
'type' => 'directory',
- 'children' => [
- 'ExportAnalysisTagDetailByTaskId',
- 'ValidateUploadTemplate',
- 'SubmitEnterpriseVocAnalysisTask',
- 'ListAnalysisTagDetailByTaskId',
- 'GetEnterpriseVocAnalysisTask',
- 'GetCategoriesByTaskId',
- ],
+ 'title' => '妙策-企业VOC挖掘',
+ 'id' => 446773,
],
[
- 'id' => 403524,
- 'title' => '妙搜-数据源',
+ 'children' => ['AddDatasetDocument', 'GetDatasetDocument', 'UpdateDatasetDocument', 'ListDatasetDocuments', 'SearchDatasetDocuments', 'DeleteDatasetDocument'],
'type' => 'directory',
- 'children' => [
- 'CreateDataset',
- 'GetDataset',
- 'UpdateDataset',
- 'ListDatasets',
- 'DeleteDataset',
- 'AddDatasetDocument',
- 'GetDatasetDocument',
- 'UpdateDatasetDocument',
- 'ListDatasetDocuments',
- 'SearchDatasetDocuments',
- 'DeleteDatasetDocument',
- ],
+ 'title' => '妙搜-数据源',
+ 'id' => 446774,
],
[
- 'id' => 403536,
- 'title' => '妙搜-智能搜索',
+ 'children' => ['RunSearchGeneration', 'ListSearchTasks', 'ListSearchTaskDialogues', 'ListSearchTaskDialogueDatas', 'RunSearchSimilarArticles'],
'type' => 'directory',
- 'children' => [
- 'RunSearchGeneration',
- 'ListSearchTasks',
- 'ListSearchTaskDialogues',
- 'ListSearchTaskDialogueDatas',
- 'RunSearchSimilarArticles',
- ],
+ 'title' => '妙搜-智能搜索',
+ 'id' => 446780,
],
[
- 'id' => 403542,
- 'title' => '系统配置-干预配置',
+ 'children' => ['ListInterveneCnt', 'ListIntervenes', 'ImportInterveneFile', 'InsertInterveneGlobalReply', 'ImportInterveneFileAsync', 'GetInterveneTemplateFileUrl', 'ClearIntervenes', 'GetInterveneGlobalReply', 'ListInterveneRules', 'ListInterveneImportTasks', 'InsertInterveneRule', 'GetInterveneRuleDetail', 'DeleteInterveneRule', 'ExportIntervenes', 'GetInterveneImportTaskInfo'],
'type' => 'directory',
- 'children' => [
- 'ListInterveneCnt',
- 'ListIntervenes',
- 'ImportInterveneFile',
- 'InsertInterveneGlobalReply',
- 'ImportInterveneFileAsync',
- 'GetInterveneTemplateFileUrl',
- 'ClearIntervenes',
- 'GetInterveneGlobalReply',
- 'ListInterveneRules',
- 'ListInterveneImportTasks',
- 'InsertInterveneRule',
- 'GetInterveneRuleDetail',
- 'DeleteInterveneRule',
- 'ExportIntervenes',
- 'GetInterveneImportTaskInfo',
- ],
+ 'title' => '系统配置-干预配置',
+ 'id' => 446781,
],
[
- 'id' => 403558,
- 'title' => '系统配置-信源管理',
+ 'children' => ['SaveDataSourceOrderConfig', 'GetDataSourceOrderConfig'],
'type' => 'directory',
- 'children' => [
- 'SaveDataSourceOrderConfig',
- 'GetDataSourceOrderConfig',
- ],
+ 'title' => '系统配置-信源管理',
+ 'id' => 446782,
],
[
- 'id' => 403561,
- 'title' => '妙读-基础操作类',
+ 'children' => ['GetDocInfo', 'GetFileContentLength', 'UploadBook', 'UploadDoc', 'ListDocs', 'DeleteDocs'],
'type' => 'directory',
- 'children' => [
- 'GetDocInfo',
- 'GetFileContentLength',
- 'UploadBook',
- 'UploadDoc',
- 'ListDocs',
- 'DeleteDocs',
- ],
+ 'title' => '妙读-基础操作类',
+ 'id' => 446783,
],
[
- 'id' => 403568,
- 'title' => '妙读-生成类',
+ 'children' => ['RunMultiDocIntroduction', 'RunDocBrainmap', 'RunDocIntroduction', 'RunDocSummary', 'RunDocWashing', 'RunBookIntroduction', 'RunBookBrainmap', 'RunCommentGeneration'],
'type' => 'directory',
- 'children' => [
- 'RunMultiDocIntroduction',
- 'RunDocBrainmap',
- 'RunDocIntroduction',
- 'RunDocSummary',
- 'RunDocWashing',
- 'RunBookIntroduction',
- 'RunBookBrainmap',
- 'RunCommentGeneration',
- ],
+ 'title' => '妙读-生成类',
+ 'id' => 446784,
],
[
- 'id' => 403577,
- 'title' => '妙读-抽取类',
+ 'children' => ['RunHotword'],
'type' => 'directory',
- 'children' => [
- 'RunHotword',
- ],
+ 'title' => '妙读-抽取类',
+ 'id' => 446785,
],
[
- 'id' => 403579,
- 'title' => '妙读-问答类',
+ 'children' => ['RunGenerateQuestions', 'RunDocQa'],
'type' => 'directory',
- 'children' => [
- 'RunGenerateQuestions',
- 'RunDocQa',
- ],
+ 'title' => '妙读-问答类',
+ 'id' => 446786,
],
[
- 'id' => 403582,
- 'title' => '妙读-其他',
+ 'children' => ['RunDocTranslation', 'RunDocSmartCard', 'RunBookSmartCard'],
'type' => 'directory',
- 'children' => [
- 'RunDocTranslation',
- 'RunDocSmartCard',
- 'RunBookSmartCard',
- ],
+ 'title' => '妙读-其他',
+ 'id' => 446787,
],
[
- 'id' => 403586,
- 'title' => '深度写作',
+ 'children' => ['SubmitDeepWriteTask', 'GetDeepWriteTask', 'GetDeepWriteTaskResult', 'CancelDeepWriteTask', 'RunDeepWriting'],
'type' => 'directory',
- 'children' => [
- 'SubmitDeepWriteTask',
- 'GetDeepWriteTask',
- 'GetDeepWriteTaskResult',
- 'CancelDeepWriteTask',
- 'RunDeepWriting',
- ],
+ 'title' => '深度写作',
+ 'id' => 446788,
],
[
- 'id' => 403592,
- 'title' => 'PPT生成',
+ 'children' => ['ListEnterprisePptTemplates', 'InitiatePptCreationV2', 'ListPptTemplates', 'GetPptTemplateSelector', 'GetPptArtifactExportResult', 'ExportPptArtifact', 'GetPptArtifact', 'ListPptArtifacts', 'RunPptOutlineGeneration', 'InitiatePptCreation', 'GetPptConfig', 'BindPptArtifact', 'DeletePptArtifact'],
'type' => 'directory',
- 'children' => [
- 'GetPptArtifact',
- 'ListPptArtifacts',
- 'RunPptOutlineGeneration',
- 'InitiatePptCreation',
- 'GetPptConfig',
- 'BindPptArtifact',
- 'DeletePptArtifact',
- ],
+ 'title' => 'PPT生成',
+ 'id' => 446789,
],
[
- 'id' => 403600,
- 'title' => '标书生成',
+ 'children' => ['AsyncUploadTenderDoc', 'GetBiddingRemainLimitNum', 'GetBiddingDocInfo', 'EditBiddingDoc', 'DownloadBiddingDoc', 'AsyncWritingBiddingDoc', 'ListBiddingDoc'],
'type' => 'directory',
- 'children' => [
- 'AsyncUploadTenderDoc',
- 'GetBiddingRemainLimitNum',
- 'GetBiddingDocInfo',
- 'EditBiddingDoc',
- 'DownloadBiddingDoc',
- 'AsyncWritingBiddingDoc',
- 'ListBiddingDoc',
- ],
+ 'title' => '标书生成',
+ 'id' => 446790,
],
[
- 'id' => 403608,
- 'title' => '其他',
+ 'children' => ['RunVideoScriptGenerate', 'GetSmartClipTask', 'SubmitSmartClipTask', 'SaveOrUpdateOssConfig', 'CreateDataPermissions', 'DeleteDataPermissions', 'ListDataPermissions', 'GenerateViewPoint', 'CreateDataset', 'DeleteDataset', 'FetchParseDocumentLayoutTask', 'GetDataset', 'GetPptInfo', 'ListDatasets', 'SubmitParseDocumentLayoutTask', 'UpdateDataset'],
'type' => 'directory',
- 'children' => [
- 'RunVideoScriptGenerate',
- 'GetSmartClipTask',
- 'SubmitSmartClipTask',
- ],
+ 'title' => '其他',
+ 'id' => 446791,
],
],
'components' => [
@@ -465,44 +229,13 @@
'description' => '溯源新闻对象',
'type' => 'object',
'properties' => [
- 'Url' => [
- 'title' => 'URL',
- 'description' => 'URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.html'."\n",
- ],
- 'Title' => [
- 'title' => '标题'."\n",
- 'description' => '标题'."\n",
- 'type' => 'string',
- 'example' => '新闻标题',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-01-22 10:29:00',
- ],
- 'SearchSourceName' => [
- 'title' => '来源名称',
- 'description' => '检索源名称',
- 'type' => 'string',
- 'example' => '检索源编码'."\n"
- ."\n",
- ],
- 'SearchSource' => [
- 'title' => '来源唯一标识',
- 'description' => '检索源唯一标识',
- 'type' => 'string',
- 'example' => '检索源唯一标识',
- ],
- 'Index' => [
- 'title' => ' 对于原文文章中的索引n:[[n]]',
- 'description' => '对于原文文章中的索引n(从1开始):[[n]]',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'Url' => ['title' => 'URL', 'description' => 'URL', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'."\n"],
+ 'Title' => ['title' => '标题'."\n", 'description' => '标题'."\n", 'type' => 'string', 'example' => '新闻标题'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-01-22 10:29:00'],
+ 'SearchSourceName' => ['title' => '来源名称', 'description' => '检索源名称', 'type' => 'string', 'example' => '检索源编码'."\n"
+ ."\n"],
+ 'SearchSource' => ['title' => '来源唯一标识', 'description' => '检索源唯一标识', 'type' => 'string', 'example' => '检索源唯一标识'],
+ 'Index' => ['title' => ' 对于原文文章中的索引n:[[n]]', 'description' => '对于原文文章中的索引n(从1开始):[[n]]', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
@@ -513,24 +246,9 @@
'description' => '新闻对象',
'type' => 'object',
'properties' => [
- 'Title' => [
- 'title' => '新闻标题',
- 'description' => '新闻标题',
- 'type' => 'string',
- 'example' => '新闻标题xxx',
- ],
- 'Content' => [
- 'title' => '新闻内容',
- 'description' => '新闻内容',
- 'type' => 'string',
- 'example' => '新闻内容xxx',
- ],
- 'Url' => [
- 'title' => '新闻URL链接',
- 'description' => '新闻URL链接',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.html',
- ],
+ 'Title' => ['title' => '新闻标题', 'description' => '新闻标题', 'type' => 'string', 'example' => '新闻标题xxx'],
+ 'Content' => ['title' => '新闻内容', 'description' => '新闻内容', 'type' => 'string', 'example' => '新闻内容xxx'],
+ 'Url' => ['title' => '新闻URL链接', 'description' => '新闻URL链接', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'],
'Comments' => [
'title' => '新闻评论列表',
'description' => '新闻评论列表',
@@ -540,12 +258,7 @@
'description' => '新闻评论对象',
'type' => 'object',
'properties' => [
- 'Text' => [
- 'title' => '新闻评论内容',
- 'description' => '新闻评论内容',
- 'type' => 'string',
- 'example' => '新闻评论内容',
- ],
+ 'Text' => ['title' => '新闻评论内容', 'description' => '新闻评论内容', 'type' => 'string', 'example' => '新闻评论内容'],
],
],
],
@@ -556,39 +269,15 @@
'description' => '大纲检索结果',
'type' => 'object',
'properties' => [
- 'Query' => [
- 'title' => '检索的query',
- 'description' => '检索的query',
- 'type' => 'string',
- 'example' => '高校环保义卖案例 大学生旧物循环利用率的文章',
- ],
- 'Outline' => [
- 'title' => '检索的大纲',
- 'description' => '检索的大纲',
- 'type' => 'string',
- 'example' => '晨光中的自律:清晨6:30的校园',
- ],
- 'OutlineId' => [
- 'title' => '大纲唯一标识',
- 'description' => '大纲唯一标识',
- 'type' => 'string',
- 'example' => 'xxxxxx',
- ],
- 'PrimaryOutline' => [
- 'title' => '一级大纲',
- 'description' => '一级大纲',
- 'type' => 'string',
- 'example' => '大学生正能量的一天',
- ],
+ 'Query' => ['title' => '检索的query', 'description' => '检索的query', 'type' => 'string', 'example' => '高校环保义卖案例 大学生旧物循环利用率的文章'],
+ 'Outline' => ['title' => '检索的大纲', 'description' => '检索的大纲', 'type' => 'string', 'example' => '晨光中的自律:清晨6:30的校园'],
+ 'OutlineId' => ['title' => '大纲唯一标识', 'description' => '大纲唯一标识', 'type' => 'string', 'example' => 'xxxxxx'],
+ 'PrimaryOutline' => ['title' => '一级大纲', 'description' => '一级大纲', 'type' => 'string', 'example' => '大学生正能量的一天'],
'Articles' => [
'title' => '检索到的素材列表',
'description' => '检索到的素材列表',
'type' => 'array',
- 'items' => [
- 'title' => '检索到的素材',
- 'description' => '检索到的素材',
- '$ref' => '#/components/schemas/OutlineWritingArticle',
- ],
+ 'items' => ['title' => '检索到的素材', 'description' => '检索到的素材', '$ref' => '#/components/schemas/OutlineWritingArticle'],
],
],
],
@@ -597,54 +286,14 @@
'description' => '新闻或素材对象',
'type' => 'object',
'properties' => [
- 'Url' => [
- 'title' => '新闻URL',
- 'description' => '新闻URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxxx.html',
- ],
- 'Title' => [
- 'title' => '新闻标题',
- 'description' => '新闻标题',
- 'type' => 'string',
- 'example' => '新闻标题',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '新闻内容',
- ],
- 'SearchSource' => [
- 'title' => '检索源Code',
- 'description' => '检索源编码',
- 'type' => 'string',
- 'example' => '检索源编码',
- ],
- 'SearchSourceName' => [
- 'title' => '检索名称',
- 'description' => '检索名称',
- 'type' => 'string',
- 'example' => '检索源名称',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2023-04-11 06:14:07',
- ],
- 'PrimaryOutline' => [
- 'title' => '该素材属于的哪一个一级大纲',
- 'description' => '该素材属于的哪一个一级大纲',
- 'type' => 'string',
- 'example' => '一级大纲名称',
- ],
- 'Outline' => [
- 'title' => '该素材属于的哪一个叶子大纲',
- 'description' => '该素材属于的哪一个叶子大纲',
- 'type' => 'string',
- 'example' => '大纲名称',
- ],
+ 'Url' => ['title' => '新闻URL', 'description' => '新闻URL', 'type' => 'string', 'example' => 'http://www.example.com/xxxx.html'],
+ 'Title' => ['title' => '新闻标题', 'description' => '新闻标题', 'type' => 'string', 'example' => '新闻标题'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '新闻内容'],
+ 'SearchSource' => ['title' => '检索源Code', 'description' => '检索源编码', 'type' => 'string', 'example' => '检索源编码'],
+ 'SearchSourceName' => ['title' => '检索名称', 'description' => '检索名称', 'type' => 'string', 'example' => '检索源名称'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2023-04-11 06:14:07'],
+ 'PrimaryOutline' => ['title' => '该素材属于的哪一个一级大纲', 'description' => '该素材属于的哪一个一级大纲', 'type' => 'string', 'example' => '一级大纲名称'],
+ 'Outline' => ['title' => '该素材属于的哪一个叶子大纲', 'description' => '该素材属于的哪一个叶子大纲', 'type' => 'string', 'example' => '大纲名称'],
],
],
'TopicSelection' => [
@@ -652,19 +301,9 @@
'description' => '选题对象',
'type' => 'object',
'properties' => [
- 'Point' => [
- 'title' => '选题视角',
- 'description' => '选题视角',
- 'type' => 'string',
- 'example' => '选题视角'."\n"
- ."\n",
- ],
- 'Summary' => [
- 'title' => '选题摘要',
- 'description' => '选题摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
+ 'Point' => ['title' => '选题视角', 'description' => '选题视角', 'type' => 'string', 'example' => '选题视角'."\n"
+ ."\n"],
+ 'Summary' => ['title' => '选题摘要', 'description' => '选题摘要', 'type' => 'string', 'example' => '摘要'],
'Outlines' => [
'title' => '选题大纲列表',
'description' => '选题大纲列表',
@@ -674,18 +313,8 @@
'description' => '选题大纲对象',
'type' => 'object',
'properties' => [
- 'Outline' => [
- 'title' => '选题大纲',
- 'description' => '选题大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
+ 'Outline' => ['title' => '选题大纲', 'description' => '选题大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '摘要'],
],
],
],
@@ -696,58 +325,26 @@
'description' => '写作大纲',
'type' => 'object',
'properties' => [
- 'WritingTips' => [
- 'title' => '该大纲写作要求',
- 'description' => '大纲写作要求、写作提示',
- 'type' => 'string',
- 'example' => '大纲写作要求、写作提示',
- ],
- 'OutlineId' => [
- 'title' => '大纲唯一标识',
- 'description' => '大纲唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲名称',
- ],
+ 'WritingTips' => ['title' => '该大纲写作要求', 'description' => '大纲写作要求、写作提示', 'type' => 'string', 'example' => '大纲写作要求、写作提示'],
+ 'OutlineId' => ['title' => '大纲唯一标识', 'description' => '大纲唯一标识', 'type' => 'string', 'example' => 'xxx'],
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲名称'],
'SearchKeyWordList' => [
'title' => '大纲写作检索关键词列表',
'description' => '大纲写作检索关键词列表',
'type' => 'array',
- 'items' => [
- 'title' => '大纲写作检索关键词',
- 'description' => '大纲写作检索关键词',
- 'type' => 'string',
- 'example' => '检索关键词',
- ],
- ],
- 'WordCount' => [
- 'title' => '字数要求。1K字、2K字,不低于500字。等等',
- 'description' => '写作字数要求的描述。1K字、2K字,不低于500字。等等',
- 'type' => 'string',
- 'example' => '写作字数要求的描述',
+ 'items' => ['title' => '大纲写作检索关键词', 'description' => '大纲写作检索关键词', 'type' => 'string', 'example' => '检索关键词'],
],
+ 'WordCount' => ['title' => '字数要求。1K字、2K字,不低于500字。等等', 'description' => '写作字数要求的描述。1K字、2K字,不低于500字。等等', 'type' => 'string', 'example' => '写作字数要求的描述'],
'Articles' => [
'description' => '大纲引用的文章列表',
'type' => 'array',
- 'items' => [
- 'description' => '大纲引用的文章',
- '$ref' => '#/components/schemas/OutlineWritingArticle',
- ],
+ 'items' => ['description' => '大纲引用的文章', '$ref' => '#/components/schemas/OutlineWritingArticle'],
],
'Children' => [
'title' => '子大纲列表',
'description' => '子大纲列表',
'type' => 'array',
- 'items' => [
- 'title' => '子大纲',
- 'description' => '子大纲',
- '$ref' => '#/components/schemas/WritingOutline',
- ],
+ 'items' => ['title' => '子大纲', 'description' => '子大纲', '$ref' => '#/components/schemas/WritingOutline'],
],
],
],
@@ -760,10 +357,7 @@
'title' => '模板表单列表',
'description' => '模板表单列表',
'type' => 'array',
- 'items' => [
- 'description' => '字段。',
- '$ref' => '#/components/schemas/WritingStyleTemplateField',
- ],
+ 'items' => ['description' => '字段。', '$ref' => '#/components/schemas/WritingStyleTemplateField'],
],
'Example' => [
'title' => '表单的示例',
@@ -774,18 +368,8 @@
'description' => '表单对象',
'type' => 'object',
'properties' => [
- 'Value' => [
- 'title' => '表单值',
- 'description' => '表单值',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'Key' => [
- 'title' => '表单KEY',
- 'description' => '表单KEY',
- 'type' => 'string',
- 'example' => 'topic',
- ],
+ 'Value' => ['title' => '表单值', 'description' => '表单值', 'type' => 'string', 'example' => '123'],
+ 'Key' => ['title' => '表单KEY', 'description' => '表单KEY', 'type' => 'string', 'example' => 'topic'],
],
],
],
@@ -796,53 +380,13 @@
'description' => '写作文体表单字段定义',
'type' => 'object',
'properties' => [
- 'MinItemLength' => [
- 'title' => '数组内每个元素的最小长度',
- 'description' => '数组内每个元素的最小长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'Max' => [
- 'title' => '数值输入的最大值',
- 'description' => '数值输入的最大值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2000',
- ],
- 'MinLength' => [
- 'title' => '字符输入最小长度',
- 'description' => '字符输入最小长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'MaxLength' => [
- 'title' => '字符输入最大长度',
- 'description' => '字符输入最大长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2000',
- ],
- 'MaxItemLength' => [
- 'title' => '数组内每个元素的最大长度',
- 'description' => '数组内每个元素的最大长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4000',
- ],
- 'Name' => [
- 'title' => '表单名称',
- 'description' => '表单名称',
- 'type' => 'string',
- 'example' => '字段名称',
- ],
- 'BuildIn' => [
- 'title' => '是否为内置字段',
- 'description' => '是否为内置字段',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'MinItemLength' => ['title' => '数组内每个元素的最小长度', 'description' => '数组内每个元素的最小长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'Max' => ['title' => '数值输入的最大值', 'description' => '数值输入的最大值', 'type' => 'number', 'format' => 'double', 'example' => '2000'],
+ 'MinLength' => ['title' => '字符输入最小长度', 'description' => '字符输入最小长度', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'MaxLength' => ['title' => '字符输入最大长度', 'description' => '字符输入最大长度', 'type' => 'integer', 'format' => 'int32', 'example' => '2000'],
+ 'MaxItemLength' => ['title' => '数组内每个元素的最大长度', 'description' => '数组内每个元素的最大长度', 'type' => 'integer', 'format' => 'int32', 'example' => '4000'],
+ 'Name' => ['title' => '表单名称', 'description' => '表单名称', 'type' => 'string', 'example' => '字段名称'],
+ 'BuildIn' => ['title' => '是否为内置字段', 'description' => '是否为内置字段', 'type' => 'boolean', 'example' => 'true'],
'Enums' => [
'title' => '表单的枚举值列表',
'description' => '表单的枚举值列表',
@@ -856,1173 +400,358 @@
'title' => '级联字段列表(详情参考 通知文体的定义)',
'description' => '级联字段列表(详情参考 通知文体的定义)',
'type' => 'array',
- 'items' => [
- 'title' => '级联字段',
- 'description' => '级联字段',
- 'type' => 'string',
- 'example' => '级联字段',
- ],
- ],
- 'Key' => [
- 'title' => '枚举的唯一KEY',
- 'description' => '枚举的唯一KEY',
- 'type' => 'string',
- 'example' => '枚举KEY',
- ],
- 'Name' => [
- 'title' => '枚举的名称',
- 'description' => '枚举的名称',
- 'type' => 'string',
- 'example' => '枚举名称',
+ 'items' => ['title' => '级联字段', 'description' => '级联字段', 'type' => 'string', 'example' => '级联字段'],
],
+ 'Key' => ['title' => '枚举的唯一KEY', 'description' => '枚举的唯一KEY', 'type' => 'string', 'example' => '枚举KEY'],
+ 'Name' => ['title' => '枚举的名称', 'description' => '枚举的名称', 'type' => 'string', 'example' => '枚举名称'],
],
],
],
- 'Min' => [
- 'title' => '数值输入的最小值',
- 'description' => '数值输入的最小值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'Required' => [
- 'title' => '该表单是否必填',
- 'description' => '该表单是否必填',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'MaxItem' => [
- 'title' => '数组的元素最大个数',
- 'description' => '数组的元素最大个数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'InitialValue' => [
- 'title' => '初始化值',
- 'description' => '初始化值',
- 'type' => 'string',
- 'example' => '初始值',
- ],
+ 'Min' => ['title' => '数值输入的最小值', 'description' => '数值输入的最小值', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'Required' => ['title' => '该表单是否必填', 'description' => '该表单是否必填', 'type' => 'boolean', 'example' => 'false'],
+ 'MaxItem' => ['title' => '数组的元素最大个数', 'description' => '数组的元素最大个数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'InitialValue' => ['title' => '初始化值', 'description' => '初始化值', 'type' => 'string', 'example' => '初始值'],
'CascadingFields' => [
'title' => '级联字段列表定义(使用方式 参考 通知文体的定义)',
'description' => '级联字段列表定义(使用方式 参考 通知文体的定义)',
'type' => 'array',
- 'items' => [
- 'title' => '级联字段',
- 'description' => '级联字段',
- '$ref' => '#/components/schemas/WritingStyleTemplateField',
- ],
+ 'items' => ['title' => '级联字段', 'description' => '级联字段', '$ref' => '#/components/schemas/WritingStyleTemplateField'],
],
'Style' => [
'title' => '前端样式定义',
'description' => '前端样式定义',
'type' => 'object',
'properties' => [
- 'Placeholder' => [
- 'title' => '输入框占位符',
- 'description' => '输入框占位符',
- 'type' => 'string',
- 'example' => '清输入Prompt',
- ],
- 'Type' => [
- 'title' => '表单对应的前端组件样式,可选值:{\\"input\\", \\"textArea\\", \\"inputNumber\\", \\"datePicker\\", \\"segmented\\", \\"select\\", \\"inputWord\\", \\"inputTree\\"}',
- 'description' => '表单对应的前端组件样式,可选值:{\\"input\\", \\"textArea\\", \\"inputNumber\\", \\"datePicker\\", \\"segmented\\", \\"select\\", \\"inputWord\\", \\"inputTree\\"}',
- 'type' => 'string',
- 'example' => 'media',
- ],
- 'ShowTime' => [
- 'title' => '日期选择器是否支持时间',
- 'description' => '日期选择器是否支持时间',
- 'type' => 'boolean',
- ],
- 'Suffix' => [
- 'title' => '输入框后缀(用来展示单位)',
- 'description' => '输入框后缀(用来展示单位)',
- 'type' => 'string',
- 'example' => '后缀',
- ],
- 'Description' => [
- 'title' => '输入框提示文案',
- 'description' => '输入框提示文案',
- 'type' => 'string',
- 'example' => '输入框提示文案',
- ],
- 'Format' => [
- 'title' => '日期格式',
- 'description' => '日期格式',
- 'type' => 'string',
- 'example' => 'yyyy-mm-dd',
- ],
+ 'Placeholder' => ['title' => '输入框占位符', 'description' => '输入框占位符', 'type' => 'string', 'example' => '清输入Prompt'],
+ 'Type' => ['title' => '表单对应的前端组件样式,可选值:{\\"input\\", \\"textArea\\", \\"inputNumber\\", \\"datePicker\\", \\"segmented\\", \\"select\\", \\"inputWord\\", \\"inputTree\\"}', 'description' => '表单对应的前端组件样式,可选值:{\\"input\\", \\"textArea\\", \\"inputNumber\\", \\"datePicker\\", \\"segmented\\", \\"select\\", \\"inputWord\\", \\"inputTree\\"}', 'type' => 'string', 'example' => 'media'],
+ 'ShowTime' => ['title' => '日期选择器是否支持时间', 'description' => '日期选择器是否支持时间', 'type' => 'boolean'],
+ 'Suffix' => ['title' => '输入框后缀(用来展示单位)', 'description' => '输入框后缀(用来展示单位)', 'type' => 'string', 'example' => '后缀'],
+ 'Description' => ['title' => '输入框提示文案', 'description' => '输入框提示文案', 'type' => 'string', 'example' => '输入框提示文案'],
+ 'Format' => ['title' => '日期格式', 'description' => '日期格式', 'type' => 'string', 'example' => 'yyyy-mm-dd'],
],
],
- 'Key' => [
- 'title' => '表单KEY',
- 'description' => '表单字段的KEY',
- 'type' => 'string',
- 'example' => 'topic',
- ],
+ 'Key' => ['title' => '表单KEY', 'description' => '表单字段的KEY', 'type' => 'string', 'example' => 'topic'],
],
],
],
],
'apis' => [
- 'CreateToken' => [
- 'summary' => '创建在线推理API的临时Token。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'PlainResult<AccessTokenInfo>',
- 'description' => 'PlainResult<AccessTokenInfo>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'ExpiredTime' => [
- 'title' => '有效期',
- 'description' => '有效期',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1705388704855',
- ],
- 'Token' => [
- 'title' => '访问授权码',
- 'description' => '访问授权码',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"ExpiredTime\\": 1705388704855,\\n \\"Token\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取授权token',
- ],
- 'ListDialogues' => [
- 'summary' => '在线推理场景的历史记录。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AddAuditTerms' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'TaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识'."\n"
- ."\n"
- .'> '."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- 'maxLength' => 64,
- 'minLength' => 6,
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'Keyword',
'in' => 'formData',
- 'schema' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-04 11:46:07',
- ],
+ 'schema' => ['title' => '关键词', 'description' => '关键词', 'type' => 'string', 'required' => false, 'example' => '龘'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'SuggestWord',
'in' => 'formData',
- 'schema' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-04 11:46:07',
- ],
+ 'schema' => ['title' => '建议词', 'description' => '建议词', 'type' => 'string', 'required' => false, 'example' => '龘(dá)'],
],
[
- 'name' => 'DialogueType',
+ 'name' => 'TermsDesc',
'in' => 'formData',
- 'schema' => [
- 'title' => '生成类型:1:创作;2:智搜(默认)',
- 'description' => '生成类型:1:创作;2:智搜(默认)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- 'default' => '2',
- 'enum' => [
- '1',
- '2',
- ],
- ],
+ 'schema' => ['title' => '审核依据', 'description' => '审核依据', 'type' => 'string', 'required' => false, 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。'],
],
[
- 'name' => 'Current',
+ 'name' => 'ExceptionWord',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '例外语句',
+ 'description' => '例外语句',
+ 'type' => 'array',
+ 'items' => ['title' => '例外语句', 'description' => '例外语句', 'type' => 'string', 'required' => false, 'example' => '例外语句'],
'required' => false,
- 'example' => '1',
],
],
[
- 'name' => 'Size',
+ 'name' => 'TermsName',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '词典名称。可选。不填默认 Default', 'description' => '词典名称。可选。不填默认 Default', 'type' => 'string', 'required' => false, 'example' => 'Default'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Current' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Data' => [
- 'description' => '生成历史列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '生成历史',
- 'type' => 'object',
- 'properties' => [
- 'Bot' => [
- 'title' => '模型生成',
- 'description' => '模型生成',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CreateTime' => [
- 'title' => '创建日期',
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DialogueType' => [
- 'title' => '生成类型:1:创作;2:智搜(默认)',
- 'description' => '生成类型:1:创作;2:智搜(默认)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'User' => [
- 'title' => '用户输入',
- 'description' => '用户输入',
- 'type' => 'string',
- 'example' => 'x',
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据(更新是否成功-已弃用-推荐使用 DataV1 拿到主键ID)', 'type' => 'boolean', 'example' => 'true'],
+ 'DataV1' => [
+ 'title' => '业务数据'."\n"
+ .'根数据版本1',
+ 'description' => '返回词库单词ID',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '562fe4163a59d7bcb44bfdde4e3d5046'],
],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Size' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'example' => '返回添加的实体信息',
],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '添加自定义词库记录',
+ 'summary' => '添加审核自定义词库记录。',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-09-08T11:43:52.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-08-15T05:32:39.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Bot\\": \\"xx\\",\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"CreateUser\\": \\"xx\\",\\n \\"DialogueType\\": 2,\\n \\"TaskId\\": \\"xx\\",\\n \\"User\\": \\"x\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
- 'title' => '生成历史列表',
- ],
- 'ListVersions' => [
- 'summary' => '获取用户购买的版本信息。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AddAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"DataV1\\": {\\n \\"Id\\": 0\\n }\\n}","type":"json"}]',
+ ],
+ 'AddDatasetDocument' => [
+ 'summary' => '添加文档到数据源。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'DatasetId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DatasetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => '数据集名称'],
+ ],
+ [
+ 'name' => 'Document',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'description' => '文档',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
+ 'DocUuid' => ['title' => '内部文档唯一ID', 'description' => '文档系统唯一ID:自动生成,不建议传入', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'Url' => ['description' => '文章URL:公网可访问地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx'],
+ 'Content' => [
+ 'description' => '内容',
'type' => 'string',
- 'example' => 'DataNotExists',
+ 'required' => false,
+ 'enumValueTitles' => [],
+ 'example' => '正文',
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'required' => false, 'example' => '文章摘要'],
+ 'Title' => ['description' => '文档标题', 'type' => 'string', 'required' => false, 'example' => '标题'],
+ 'PubTime' => ['description' => '发布时间', 'type' => 'string', 'required' => false, 'example' => '2024-12-09 13:35:40'],
+ 'SourceFrom' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'required' => false, 'example' => 'xxx媒体'],
+ 'MultimodalIndexName' => ['title' => '模型名称 todo 商业化 仅个别账号可传入', 'description' => '废弃:不可用', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'DisableHandleMultimodalMedia' => ['title' => '当前记录是否落多模态索引库', 'description' => '当前记录多模态数据(图片、视频)是否落索引库,默认true', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'MultimodalMedias' => [
+ 'description' => '文档中多模态数据列表:'."\n"
+ .'- 仅富文本等文档中存在多模态数据(图片、视频)时,可以通过这个字段传入,进而可以在搜索接口召回对应数据。'."\n"
+ .'- 文档本身为多模态数据时,此字段为空,通过docType+url指定数据即可。',
'type' => 'array',
'items' => [
- 'description' => '列表对象',
+ 'description' => '多模态数据',
'type' => 'object',
'properties' => [
- 'ConcurrentCount' => [
- 'title' => '并发数',
- 'description' => '并发数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '43',
- ],
- 'EndTime' => [
- 'title' => '服务到期时间',
- 'description' => '服务到期时间',
- 'type' => 'string',
- 'example' => '2023-04-23 02:00:34',
- ],
- 'InstanceCount' => [
- 'title' => '实例数',
- 'description' => '实例数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '55',
- ],
- 'InstanceId' => [
- 'title' => '实例ID',
- 'description' => '实例ID',
- 'type' => 'string',
- 'example' => 'ga-bp12pismsw4v3tzhf62p1',
- ],
- 'OrderId' => [
- 'title' => '订单ID',
- 'description' => '订单ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '7',
- ],
- 'ProductType' => [
- 'title' => '版本类型 (TRIAL: 试用版, STANDARD: 专业版, CUSTOMIZE: 定制版)',
- 'description' => '版本类型 (TRIAL: 试用版, STANDARD: 专业版, CUSTOMIZE: 定制版)',
- 'type' => 'string',
- 'example' => 'CUSTOMIZE',
- 'enum' => [
- 'TRIAL',
- 'STANDARD',
- 'CUSTOMIZE',
- ],
- ],
- 'Quota' => [
- 'title' => '试用版限额次数',
- 'description' => '试用版限额次数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '13',
- ],
- 'StartTime' => [
- 'title' => '服务开始时间',
- 'description' => '服务开始时间',
- 'type' => 'string',
- 'example' => '2023-05-27 04:11:00',
- ],
- 'UseQuota' => [
- 'title' => '试用版已使用次数',
- 'description' => '试用版已使用次数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '65',
- ],
- 'VersionDetail' => [
- 'title' => '版本明细',
- 'description' => '版本明细',
- 'type' => 'string',
- 'example' => '标准版-公共并发:1并发',
- ],
- 'VersionName' => [
- 'title' => '版本',
- 'description' => '版本',
- 'type' => 'string',
- 'example' => '试用版',
- 'enum' => [
- '试用版',
- '专业版',
- '定制版',
- ],
- ],
- 'VersionStatus' => [
- 'title' => '有效状态:0-表示有效、1-版本过期-续费页、2-版本不可用-购买页',
- 'description' => '有效状态:0-表示有效、1-版本过期-续费页、2-版本不可用-购买页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '87',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识:不建议传入,系统会自动生成', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据类型:'."\n"
+ .'- image:图片'."\n"
+ .'- video:视频', 'type' => 'string', 'required' => false, 'example' => 'image'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件地址:公网可访问', 'type' => 'string', 'required' => false, 'example' => 'http://xxx'],
],
+ 'required' => false,
],
+ 'required' => false,
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": [\\n {\\n \\"ConcurrentCount\\": 43,\\n \\"EndTime\\": \\"2023-04-23 02:00:34\\",\\n \\"InstanceCount\\": 55,\\n \\"InstanceId\\": \\"ga-bp12pismsw4v3tzhf62p1\\",\\n \\"OrderId\\": 7,\\n \\"ProductType\\": \\"CUSTOMIZE\\",\\n \\"Quota\\": 13,\\n \\"StartTime\\": \\"2023-05-27 04:11:00\\",\\n \\"UseQuota\\": 65,\\n \\"VersionDetail\\": \\"标准版-公共并发:1并发\\",\\n \\"VersionName\\": \\"试用版\\",\\n \\"VersionStatus\\": 87\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取版本信息',
- ],
- 'GetProperties' => [
- 'summary' => '获取配置信息。包括不限于智能配置的风格,推理相关元数据配置等。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx_efm',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<TongYiLlmPropertiesDO>',
- 'description' => 'PlainResult<TongYiLlmPropertiesDO>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'DocId' => ['title' => '业务文档唯一ID', 'description' => '文档业务侧唯一ID', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'DocType' => ['title' => '文档类型', 'description' => '文档类型:'."\n"
+ .'- plainText:纯文本,content必选'."\n"
+ .'- richText:富文本:html,content必选'."\n"
+ .'- text:文本文件,url必选'."\n"
+ .'- pdf:url必选'."\n"
+ .'- word:url必选'."\n"
+ .'- image:图片,url必选,支持gif、png、jpg、jpeg等大多数常见图片格式'."\n"
+ .'- video:视频,url必选,支持MP4、AVI、WMV、MOV等大多数常见视频格式', 'type' => 'string', 'required' => false, 'example' => 'image'],
+ 'Extend1' => ['title' => '扩展字段1', 'description' => '扩展字段1', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Extend2' => ['title' => '扩展字段2', 'description' => '扩展字段2', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'Extend3' => ['title' => '扩展字段3', 'description' => '扩展字段3', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Metadata' => [
+ 'title' => '字典信息:目前仅视频支持',
+ 'description' => 'meta信息',
'type' => 'object',
'properties' => [
- 'ChatConfig' => [
- 'title' => '通话配置',
- 'description' => '通话配置',
- 'type' => 'object',
- ],
- 'ConsoleConfig' => [
- 'title' => '控制台配置',
- 'description' => '控制台配置',
- 'type' => 'object',
- 'properties' => [
- 'TipContent' => [
- 'title' => '提示内容',
- 'description' => '提示内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'AI妙笔',
- ],
- ],
- ],
- 'GeneralConfigMap' => [
- 'title' => '通用配置表',
- 'description' => '通用配置表',
- 'type' => 'object',
- ],
- 'IntelligentSearchConfig' => [
- 'title' => '智搜配置',
- 'description' => '智搜配置',
- 'type' => 'object',
- 'properties' => [
- 'ProductDescription' => [
- 'title' => '首页产品描述',
- 'description' => '首页产品描述',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'SearchSamples' => [
- 'title' => '智搜推荐',
- 'description' => '智搜推荐',
- 'type' => 'array',
- 'items' => [
- 'description' => 'sample',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '文章列表',
- 'description' => '文章列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章',
- 'type' => 'object',
- 'properties' => [
- 'Select' => [
- 'title' => '前端传递时是否手动选择',
- 'description' => '前端传递时是否手动选择',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Stared' => [
- 'title' => '是否为星标文章',
- 'description' => '是否为星标文章',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'http://xxx.com',
- ],
- ],
- ],
- ],
- 'Prompt' => [
- 'title' => '提示词',
- 'description' => '提示词',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Text' => [
- 'title' => '生成内容',
- 'description' => '生成内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- ],
- 'SearchSources' => [
- 'title' => '搜索源列表',
- 'description' => '搜索源列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '搜索源',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '数据集唯一标识: code+datasetName',
- 'description' => '数据集唯一标识: code+datasetName',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DatasetName' => [
- 'title' => '数据集唯一标识: code+datasetName',
- 'description' => '数据集唯一标识: code+datasetName',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Name' => [
- 'title' => '搜索源名称:中文',
- 'description' => '搜索源名称:中文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- 'CopilotPreciseSearchSources' => [
- 'title' => '妙搜:搜索源配置',
- 'description' => '妙搜:搜索源配置',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '数据集唯一标识: code+datasetName',
- 'description' => '数据集唯一标识: code+datasetName',
- 'type' => 'string',
- 'example' => 'x',
- ],
- 'DatasetName' => [
- 'title' => '数据集唯一标识: code+datasetName',
- 'description' => '数据集唯一标识: code+datasetName',
- 'type' => 'string',
- 'example' => 'x',
- ],
- 'Name' => [
- 'title' => '搜索源名称:中文',
- 'description' => '搜索源名称:中文',
- 'type' => 'string',
- 'example' => 'x',
- ],
- ],
- ],
- ],
- ],
- ],
- 'SearchSources' => [
- 'title' => '搜索源',
- 'description' => '搜索源下拉列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '搜索源',
- 'type' => 'object',
- 'properties' => [
- 'Label' => [
- 'title' => '下拉列表的展示值',
- 'description' => '搜索源名称',
- 'type' => 'string',
- 'example' => '夸克通用搜索',
- ],
- 'Value' => [
- 'title' => '下拉列表的传递值',
- 'description' => '搜索源code',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- ],
- ],
- ],
- 'SlrAuthorized' => [
- 'title' => 'SLR 是否已经授权',
- 'description' => 'SLR 是否已经授权',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'UserInfo' => [
- 'title' => '用户配置',
- 'description' => '用户配置',
- 'type' => 'object',
- 'properties' => [
- 'AgentId' => [
- 'title' => '业务空间唯一标识',
- 'description' => '业务空间唯一标识',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'TenantId' => [
- 'title' => '租户唯一标识',
- 'description' => '租户唯一标识',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'UserId' => [
- 'title' => '用户id',
- 'description' => '用户id',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Username' => [
- 'title' => '用户名称',
- 'description' => '用户名称',
- 'type' => 'string',
- 'example' => 'admin',
- ],
- ],
- ],
- 'WanxiangImageSizeConfig' => [
- 'title' => '万相图片尺寸',
- 'description' => '万相图片',
+ 'VideoShots' => [
+ 'title' => '视频分镜信息:比如视频理解语言分析结果',
+ 'description' => '分镜信息',
'type' => 'array',
'items' => [
- 'description' => '万相图片尺寸',
+ 'title' => '分镜信息',
+ 'description' => '分镜信息',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '图片尺寸比例',
- 'description' => '图片尺寸比例',
- 'type' => 'string',
- 'example' => '1:1',
- ],
- 'Value' => [
- 'title' => '图片尺寸像素',
- 'description' => '图片尺寸像素',
- 'type' => 'string',
- 'example' => '1024*1024',
- ],
+ 'StartTime' => ['title' => '分镜开始时间:单位毫秒', 'description' => '开始时间;毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
+ 'EndTime' => ['title' => '分镜结束时间:单位毫秒', 'description' => '结束时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000'],
+ 'Text' => ['title' => '分镜:总结内容', 'description' => '分镜分析文本信息', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
+ 'required' => false,
],
+ 'required' => false,
],
- 'WanxiangImageStyleConfig' => [
- 'title' => '万相图片风格配置',
- 'description' => '万相图片风格配置',
+ 'AsrSentences' => [
+ 'title' => 'asr结果',
+ 'description' => '语音或者字幕信息',
'type' => 'array',
'items' => [
+ 'title' => 'asr结果',
+ 'description' => '语音或者字幕信息',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'title' => '风格名称',
- 'description' => '风格名称',
- 'type' => 'string',
- 'example' => '默认',
- ],
- 'Pic' => [
- 'title' => '风格图片地址',
- 'description' => '风格图片地址',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png',
- ],
- 'Value' => [
- 'title' => '风格code',
- 'description' => '风格code',
- 'type' => 'string',
- 'example' => '<auto>',
- ],
+ 'StartTime' => ['title' => '开始时间:单位毫秒', 'description' => '开始时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'],
+ 'EndTime' => ['title' => '结束时间:单位毫秒', 'description' => '技术时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000'],
+ 'Text' => ['title' => 'asr内容', 'description' => '语音或者字幕信息', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
+ 'required' => false,
],
+ 'required' => false,
],
- 'SearchSourceList' => [
- 'description' => '指定的搜索源列表',
+ 'Text' => ['title' => '整体总结信息', 'description' => 'meta描述信息:废弃字段', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'KeyValues' => [
+ 'description' => 'keyValue结构metadata',
'type' => 'array',
'items' => [
+ 'description' => 'keyValue结构metadata',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '搜索源类型:对应(SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索)',
- 'description' => '搜索源类型:对应(SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索)',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'Name' => [
- 'title' => '搜索源描述',
- 'description' => '搜索源描述',
- 'type' => 'string',
- 'example' => '互联网检索',
- ],
- 'DatasetName' => [
- 'title' => '数据源唯一标识',
- 'description' => '数据源唯一标识',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- ],
- ],
- ],
- 'MiaosouConfig' => [
- 'title' => '妙搜配置',
- 'description' => '妙搜配置',
- 'type' => 'object',
- 'properties' => [
- 'UseDocSize' => [
- 'title' => '数据集已使用文档数',
- 'description' => '数据集已使用文档数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'MaxDocSize' => [
- 'title' => '数据集可用文档数',
- 'description' => '数据集可用文档数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ModelInfos' => [
- 'title' => '智能搜索支持的模型列表',
- 'description' => '智能搜索支持的模型列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '智能搜索支持的模型',
- 'description' => '智能搜索支持的模型',
- 'type' => 'object',
- 'properties' => [
- 'ModelName' => [
- 'title' => '模型名称',
- 'description' => '模型名称',
- 'type' => 'string',
- 'example' => '全妙-Max',
- ],
- 'ModelId' => [
- 'title' => '模型id',
- 'description' => '模型id',
- 'type' => 'string',
- 'example' => 'quanmiao-max',
- ],
- ],
- ],
+ 'Key' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'Value' => ['description' => '参数值', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
+ 'required' => false,
],
+ 'required' => false,
],
],
+ 'required' => false,
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'Tags' => [
+ 'description' => '标签名称',
+ 'type' => 'array',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'required' => false,
],
],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": {\\n \\"ChatConfig\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ConsoleConfig\\": {\\n \\"TipContent\\": \\"xx\\",\\n \\"Title\\": \\"AI妙笔\\"\\n },\\n \\"GeneralConfigMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"IntelligentSearchConfig\\": {\\n \\"ProductDescription\\": \\"xxx\\",\\n \\"SearchSamples\\": [\\n {\\n \\"Articles\\": [\\n {\\n \\"Select\\": true,\\n \\"Stared\\": false,\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"http://xxx.com\\"\\n }\\n ],\\n \\"Prompt\\": \\"xx\\",\\n \\"Text\\": \\"xxx\\"\\n }\\n ],\\n \\"SearchSources\\": [\\n {\\n \\"Code\\": \\"xx\\",\\n \\"DatasetName\\": \\"xx\\",\\n \\"Name\\": \\"xx\\"\\n }\\n ],\\n \\"CopilotPreciseSearchSources\\": [\\n {\\n \\"Code\\": \\"x\\",\\n \\"DatasetName\\": \\"x\\",\\n \\"Name\\": \\"x\\"\\n }\\n ]\\n },\\n \\"SearchSources\\": [\\n {\\n \\"Label\\": \\"夸克通用搜索\\",\\n \\"Value\\": \\"SystemSearch\\"\\n }\\n ],\\n \\"SlrAuthorized\\": true,\\n \\"UserInfo\\": {\\n \\"AgentId\\": \\"1\\",\\n \\"TenantId\\": \\"1\\",\\n \\"UserId\\": \\"1\\",\\n \\"Username\\": \\"admin\\"\\n },\\n \\"WanxiangImageSizeConfig\\": [\\n {\\n \\"Name\\": \\"1:1\\",\\n \\"Value\\": \\"1024*1024\\"\\n }\\n ],\\n \\"WanxiangImageStyleConfig\\": [\\n {\\n \\"Name\\": \\"默认\\",\\n \\"Pic\\": \\"https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png\\",\\n \\"Value\\": \\"<auto>\\"\\n }\\n ],\\n \\"SearchSourceList\\": [\\n {\\n \\"Code\\": \\"SystemSearch\\",\\n \\"Name\\": \\"互联网检索\\",\\n \\"DatasetName\\": \\"QuarkCommonNews\\"\\n }\\n ],\\n \\"MiaosouConfig\\": {\\n \\"UseDocSize\\": 1,\\n \\"MaxDocSize\\": 1,\\n \\"ModelInfos\\": [\\n {\\n \\"ModelName\\": \\"全妙-Max\\",\\n \\"ModelId\\": \\"quanmiao-max\\"\\n }\\n ]\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取配置信息',
- ],
- 'GenerateFileUrlByKey' => [
- 'summary' => '生成临时可访问的公开url。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'FileKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文件key。格式为:protocol://serverInstance/bucketPath/fileKey',
- 'description' => '文件key。格式为:protocol://serverInstance/bucketPath/fileKey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
- ],
- [
- 'name' => 'FileName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '文件名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.docx',
],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<URL>',
- 'description' => 'PlainResult<URL>',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'string',
- 'example' => 'https://www.example.com/a.txt',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocUuid' => ['description' => '文档系统唯一标识', 'type' => 'string', 'example' => '8df2d69d63a247b6b52ff455b2d426b6'],
+ 'DocId' => ['title' => '文档业务唯一标识', 'description' => '文档业务侧唯一标识', 'type' => 'string', 'example' => 'xxx'],
+ 'Status' => ['title' => '状态:', 'description' => '状态:'."\n"
+ .'- 1:创建完成'."\n"
+ .'- 2:文本索引构建完成'."\n"
+ .'- 3:多模态索引构建完成'."\n"
+ .'- 100:全量构建完成'."\n"
+ .'- 0:失败', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ErrorCode' => ['description' => '异常错误码', 'type' => 'string', 'example' => 'Success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ ],
],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": \\"https://www.example.com/a.txt\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '生成文件URL',
- ],
- 'GenerateUploadConfig' => [
- 'summary' => '生成文件上传配置。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-添加文档到数据集',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AddDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DocUuid\\": \\"8df2d69d63a247b6b52ff455b2d426b6\\",\\n \\"DocId\\": \\"xxx\\",\\n \\"Status\\": 1,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"错误信息\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'AsyncCreateClipsTask' => [
+ 'summary' => '生成剪辑视频',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2030,154 +759,298 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务唯一ID', 'type' => 'string', 'required' => true, 'example' => '17a299a9-f223-4707-b0dd-4c22519bddf5', 'title' => '任务唯一ID'],
+ ],
+ [
+ 'name' => 'VoiceStyle',
+ 'in' => 'formData',
+ 'schema' => ['description' => '口播语音类型', 'type' => 'string', 'required' => false, 'example' => '甜美女声'."\n"
+ .'中国台湾话女声'."\n"
+ .'舌尖男声'."\n"
+ .'新闻男声'."\n"
+ .'激昂解说'."\n"
+ .'标准女声'."\n"
+ .'悬疑解说'."\n"
+ .'广告男声'."\n"
+ .'温柔女声'."\n"
+ .'资讯女声'."\n"
+ .'新闻女声'."\n"
+ .'萝莉女声'."\n"
+ .'磁性男声', 'title' => '口播语音类型'],
+ ],
+ [
+ 'name' => 'MusicUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => '背景音乐地址', 'type' => 'string', 'required' => false, 'example' => 'http://music.mp4', 'title' => '背景音乐地址'],
+ ],
+ [
+ 'name' => 'ColorWords',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
+ 'description' => '花字数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '花字结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '花字内容', 'type' => 'string', 'required' => false, 'example' => '花字内容', 'title' => '花字内容'],
+ 'TimelineIn' => ['description' => '花字出现时间(秒)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => '花字出现时间(秒)'],
+ 'TimelineOut' => ['description' => '花字结束时间(秒)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => '花字结束时间(秒)'],
+ 'X' => ['description' => '花字位置横坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.2', 'title' => '花字位置横坐标'],
+ 'Y' => ['description' => '花字位置纵坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.5', 'title' => '花字位置纵坐标'],
+ 'FontSize' => ['description' => '花字大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '默认120', 'title' => '花字大小'],
+ 'EffectColorStyle' => ['description' => '花字样式', 'type' => 'string', 'required' => false, 'example' => 'CS0002-000007'."\n"
+ .'参考:https://help.aliyun.com/zh/ims/developer-reference/flower-effect-example?spm=a2c4g.11186623.0.0.6ee43d29lo1EWu#88bc5f6046mg2', 'title' => '花字样式'],
+ ],
+ 'required' => false,
+ 'title' => '花字数组',
+ ],
+ 'required' => false,
+ 'title' => '花字数组',
],
],
[
- 'name' => 'FileName',
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '[百炼业务空间Id](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-ipe7d81yq4sl5jmk', 'title' => '[百炼业务空间Id](~~2782167~~)'],
+ ],
+ [
+ 'name' => 'VoiceVolume',
+ 'in' => 'formData',
+ 'schema' => ['description' => '口播音量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0-10,默认5', 'title' => '口播音量'],
+ ],
+ [
+ 'name' => 'MusicVolume',
+ 'in' => 'formData',
+ 'schema' => ['description' => '音乐音量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0-10,默认5', 'title' => '音乐音量'],
+ ],
+ [
+ 'name' => 'SubtitleFontSize',
+ 'in' => 'formData',
+ 'schema' => ['description' => '字幕尺寸', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '默认120', 'title' => '字幕尺寸'],
+ ],
+ [
+ 'name' => 'Height',
'in' => 'formData',
+ 'schema' => ['description' => '视频高度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920', 'title' => '视频高度'],
+ ],
+ [
+ 'name' => 'Width',
+ 'in' => 'formData',
+ 'schema' => ['description' => '视频宽度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1080', 'title' => '视频宽度'],
+ ],
+ [
+ 'name' => 'CloseVoice',
+ 'in' => 'formData',
+ 'schema' => ['title' => '关闭口播', 'description' => '关闭口播', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'CloseMusic',
+ 'in' => 'formData',
+ 'schema' => ['title' => '关闭背景音乐', 'description' => '关闭背景音乐', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'CloseSubtitle',
+ 'in' => 'formData',
+ 'schema' => ['title' => '关闭字幕', 'description' => '关闭字幕', 'type' => 'boolean', 'required' => false],
+ ],
+ [
+ 'name' => 'CustomVoiceUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义声道语音地址', 'description' => '自定义声道语音地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.mp4'],
+ ],
+ [
+ 'name' => 'CustomVoiceVolume',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义声道音量', 'description' => '自定义声道音量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'Stickers',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '文件名称',
- 'description' => '文件名称',
- 'type' => 'string',
+ 'title' => '贴纸结构数组',
+ 'description' => '贴纸结构数组',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '贴纸数组元素',
+ 'description' => '贴纸数组元素',
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => 'gif文件公网地址', 'description' => 'gif文件公网地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.gif'],
+ 'TimelineIn' => ['title' => '贴纸开始时间(妙)', 'description' => '贴纸开始时间(妙)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
+ 'Duration' => ['title' => '贴纸显示时间(秒)', 'description' => '贴纸显示时间(秒)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'X' => ['title' => '贴纸位置x坐标', 'description' => '贴纸位置x坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '200'],
+ 'Y' => ['title' => '贴纸位置y坐标', 'description' => '贴纸位置y坐标', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '200'],
+ 'Width' => ['title' => '贴纸宽度', 'description' => '贴纸宽度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'Height' => ['title' => '贴纸高度', 'description' => '贴纸高度', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ 'DyncFrames' => ['title' => 'gif文件动态帧数', 'description' => 'gif文件动态帧数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '8'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'test.docx',
],
],
[
- 'name' => 'ParentDir',
+ 'name' => 'CustomVoiceStyle',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'cosyvoice的音色', 'type' => 'string', 'required' => false, 'example' => 'longxian_normal', 'title' => 'cosyvoice的音色'],
+ ],
+ [
+ 'name' => 'CosyVoiceAppKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'cosyvoice的appkey', 'type' => 'string', 'required' => false, 'example' => 'ddgsase', 'title' => 'cosyvoice的appkey'],
+ ],
+ [
+ 'name' => 'CosyVoiceToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => 'cosyvoice的token', 'type' => 'string', 'required' => false, 'example' => 'xxsfazs', 'title' => 'cosyvoice的token'],
+ ],
+ [
+ 'name' => 'MusicStyle',
'in' => 'formData',
+ 'schema' => ['description' => '推荐音乐类型', 'type' => 'string', 'required' => false, 'example' => '浪漫, 美食,国风,轻快,动感,舒缓,搞怪,时尚', 'title' => '推荐音乐类型'],
+ ],
+ [
+ 'name' => 'OpeningCreditsUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => '片头视频地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.mp4', 'title' => '片头视频地址'],
+ ],
+ [
+ 'name' => 'ClosingCreditsUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => '片尾视频地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.mp4', 'title' => '片尾视频地址'],
+ ],
+ [
+ 'name' => 'HighDefSourceVideos',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '父目录 (materialDocument: 素材库, intervenes: 干预上传, temp: 临时上传目录, imageGenerate: 图像生成, datasetUpload: 数据集上传)',
- 'description' => '父目录:'."\n"
- .'- materialDocument: 妙笔-素材库'."\n"
- .'- datasetUpload: 妙搜-数据集'."\n"
- .'- intervenes:干预'."\n"
- .'- temp: 临时上传目录(周期释放)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dataset',
- 'enum' => [
- 'materialDocument',
- 'intervenes',
- 'temp',
- 'imageGenerate',
- 'datasetUpload',
- 'deepWrite',
+ 'description' => '高清视频结构列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '高清视频结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'VideoId' => ['description' => '视频id', 'type' => 'string', 'required' => false, 'example' => '00d59b6de13971f0bcd84531949c0102', 'title' => '视频id'],
+ 'VideoName' => ['description' => '视频名字', 'type' => 'string', 'required' => false, 'example' => 'video001.mp4', 'title' => '视频名字'],
+ 'VideoUrl' => ['description' => '视频URL', 'type' => 'string', 'required' => false, 'example' => 'http://fotor-cn-cutout.oss-cn-shanghai.aliyuncs.com/cutout_tmp/01ba219486f043b4b339e7080e5cf11d.mp4', 'title' => '视频URL'],
+ ],
+ 'required' => false,
+ 'title' => '高清视频结构列表',
],
+ 'required' => false,
+ 'title' => '高清视频结构列表',
],
],
+ [
+ 'name' => 'Alignment',
+ 'in' => 'formData',
+ 'schema' => ['title' => '横幅文字定位对齐方式,默认为TopLeft,', 'type' => 'string', 'example' => '支持设置:'."\n"
+ ."\n"
+ .'TopLeft:视频左上角'."\n"
+ ."\n"
+ .'TopCenter:视频竖直中轴线上侧'."\n"
+ ."\n"
+ .'TopRight:视频右上角'."\n"
+ ."\n"
+ .'CenterLeft:视频水平中轴线左侧'."\n"
+ ."\n"
+ .'CenterCenter:视频中心位置'."\n"
+ ."\n"
+ .'CenterRight:视频水平中轴线右侧'."\n"
+ ."\n"
+ .'BottomLeft:视频左下角'."\n"
+ ."\n"
+ .'BottomCenter:视频竖直中轴线下侧'."\n"
+ ."\n"
+ .'BottomRight:视频右下角'."\n"
+ ."\n"
+ .'若需要在不同对齐方式下准确定位字幕位置,建议设置以下对齐方式:'."\n"
+ ."\n"
+ .'Left,左对齐,X、Y传入字幕左上角顶点相对于视频左上角的坐标'."\n"
+ ."\n"
+ .'Center,居中对齐,X、Y传入字幕中轴线上边界交点相对于视频左上角的坐标'."\n"
+ ."\n"
+ .'Right,右对齐,X、Y传入字幕右上角顶点相对于视频左上角的坐标'],
+ ],
+ [
+ 'name' => 'AdaptMode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '适配模式,横幅文字当超出视频宽度或超出指定TextWidth时进行自动换行或缩放', 'type' => 'string', 'example' => 'AutoWrap:自动换行'."\n"
+ ."\n"
+ .'AutoScale:自动缩放'."\n"
+ ."\n"
+ .'AutoWrapAtSpaces:只在空格位置自动换行(适用于纯英文字幕自动换行场景)'],
+ ],
+ [
+ 'name' => 'TextWidth',
+ 'in' => 'formData',
+ 'schema' => ['title' => '字幕文本框宽度,当设置AdaptMode时生效。', 'type' => 'string', 'example' => '将按照该值设置文本框宽度进行自动换行或缩放。不填写时,会按照视频宽度进行自动换行或缩放。当值大于0小于等于1时,表示相对输出视频的宽度,当值大于1时,表示绝对像素值。'],
+ ],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<UploadConfig>',
- 'description' => 'PlainResult<UploadConfig>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'FileKey' => [
- 'title' => '系统内唯一标识',
- 'description' => '文件唯一标识:可以当做url给到全妙',
- 'type' => 'string',
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
- 'FormDatas' => [
- 'title' => '表单提交数据',
- 'description' => '上传oss的凭证信息:'."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "OSSAccessKeyId": "xxx",'."\n"
- .' "Signature": "xxx+xxx=",'."\n"
- .' "MaxSize": 31457280,'."\n"
- .' "key": "aimiaobi/dataset/2_2/xx.txt",'."\n"
- .' "policy": "xxx=="'."\n"
- .'}'."\n"
- .'```',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'string',
- ],
- ],
- 'PostUrl' => [
- 'title' => '如果这个为空则 postUrl 为上传服务的上传地址',
- 'description' => '上传oss的地址',
- 'type' => 'string',
- 'example' => 'https://bucket-name.oss-cn-hangzhou.aliyuncs.com',
- ],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FormDatas\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PostUrl\\": \\"https://bucket-name.oss-cn-hangzhou.aliyuncs.com\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '生成上传配置',
- 'description' => '通过这接口可以拿到文件上传的地址和凭证,参考如下文档可以完成文件上传:'."\n"
- .'[OSS-表单上传](https://help.aliyun.com/zh/oss/user-guide/form-upload?scm=20140722.H_31849._.OR_help-T_cn~zh-V_1)',
- ],
- 'SubmitAsyncTask' => [
- 'summary' => '执行系统预定义的异步任务。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建剪辑任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncCreateClipsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'AsyncCreateClipsTimeLine' => [
+ 'summary' => '智能剪辑timeline',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -2185,1261 +1058,802 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm',
- ],
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务唯一ID', 'type' => 'string', 'required' => true, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'title' => '任务唯一ID'],
],
[
- 'name' => 'TaskName',
+ 'name' => 'ProcessPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务名称',
- 'description' => '任务名称定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => '任务名称',
- ],
+ 'schema' => ['description' => '处理用prompt', 'type' => 'string', 'required' => false, 'example' => '口播内容是乌镇旅游宣传广告,口播内容时长约为1分钟,开头要描述乌镇是千年文化传承的江南水乡,之后要体现乌镇的传统手工艺、美食和美景,最后要号召大家来乌镇旅游', 'title' => '处理用prompt'],
],
[
- 'name' => 'TaskCode',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务定义,可选值:MaterialDocumentUpload:素材上传',
- 'description' => '任务定义:详见任务定义表',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'MaterialDocumentUpload',
- ],
+ 'schema' => ['description' => '[百炼工作空间Id](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => '[百炼工作空间Id](~~2782167~~)'],
],
[
- 'name' => 'TaskParam',
+ 'name' => 'CustomContent',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务提交参数',
- 'description' => '任务提交参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{"fileUrl":"https://www.example.com/aaa.doc","fileName":"文件名称","shareAttr":1}',
- ],
+ 'schema' => ['description' => '自定义口播内容', 'type' => 'string', 'required' => false, 'example' => '自定义口播内容', 'title' => '自定义口播内容'],
],
[
- 'name' => 'TaskExecuteTime',
+ 'name' => 'NoRefVideo',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否开启模仿能力', 'type' => 'boolean', 'required' => false, 'example' => '默认开启', 'title' => '是否开启模仿能力'],
+ ],
+ [
+ 'name' => 'AdditionalContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '素材附加信息,有助于口播文案的生成', 'type' => 'string', 'required' => false, 'example' => '素材附加信息', 'title' => '素材附加信息,有助于口播文案的生成'],
+ ],
+ [
+ 'name' => 'RecommendAudio',
'in' => 'formData',
+ 'schema' => ['title' => '是否在生成timeline的时候根据视频内容自动推荐音频信息', 'type' => 'boolean', 'example' => 'false'],
+ ],
+ [
+ 'name' => 'TimelineScene',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'timeline场景', 'type' => 'integer', 'format' => 'int32', 'example' => 'null - 通用口播'."\n"
+ .' 0-通用口播'."\n"
+ .' 1- 高光'],
+ ],
+ [
+ 'name' => 'HighLightConfig',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务执行时间,默认立即执行。格式:YYYY-MM-DD HH:mm:ss',
- 'description' => '任务执行时间,默认立即执行。格式:YYYY-MM-DD HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-10-14 14:30:00',
+ 'title' => '高光视频配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'HtPrompt' => ['title' => '高光描述', 'type' => 'string', 'example' => '请从输入的音乐演出视频中,自动识别并提取出「最具视觉冲击力、情感爆发力或独特吸引力」...'],
+ 'HtHighQualityLabel' => [
+ 'title' => '高光标签',
+ 'type' => 'array',
+ 'items' => ['title' => '高光标签', 'type' => 'string', 'example' => '"高清演员近景特写镜头【高优】"'],
+ 'example' => '['."\n"
+ .' "高清演员近景特写镜头【高优】",'."\n"
+ .' "演出高潮-沉浸表演【高优】",'."\n"
+ .' "演出高潮-近景表情【高优】"'."\n"
+ .']',
+ ],
+ 'HtLowQualityLabel' => [
+ 'title' => '低光标签',
+ 'type' => 'array',
+ 'items' => ['title' => '低光标签', 'type' => 'string', 'example' => ' "画面昏暗"'],
+ 'example' => '['."\n"
+ .' "画面昏暗",'."\n"
+ .' "采访画面",'."\n"
+ .' "字幕画面"'."\n"
+ .']',
+ ],
+ 'HtMinTimeLength' => ['title' => '高光最小长度', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'HtMaxTimeLength' => ['title' => '高光最大长度', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'HtSingleShotLen' => ['title' => '单镜头长度', 'type' => 'integer', 'format' => 'int32', 'example' => '1.5'],
+ 'HtAnalyzeRhythm' => ['title' => '是否分析音频', 'type' => 'boolean', 'example' => 'false'],
+ ],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<SubmitTaskResult>',
- 'description' => 'PlainResult<SubmitTaskResult>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'TaskIntermediateResult' => [
- 'title' => '中间结果',
- 'description' => '中间结果',
- 'type' => 'any',
- 'example' => '{}',
- ],
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '任务名称',
- ],
+ 'TaskId' => ['description' => '任务id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxx\\",\\n \\"TaskIntermediateResult\\": \\"{}\\",\\n \\"TaskName\\": \\"任务名称\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交异步任务',
- ],
- 'CancelAsyncTask' => [
- 'summary' => '取消已提交,尚未执行完成的异步任务。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建剪辑口播时间线',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncCreateClipsTimeLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'AsyncEditTimeline' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务唯一标识', 'type' => 'string', 'required' => true, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba'],
+ ],
+ [
+ 'name' => 'Timelines',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
+ 'description' => '剪辑时间线数组结构',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Clips' => [
+ 'description' => '剪辑片段数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '剪辑片段',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutEx' => ['description' => '片段结束时间(毫秒)', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '3.66'],
+ 'ClipId' => ['description' => '片段ID。', 'type' => 'string', 'required' => false, 'example' => '123jjdax'."\n"
+ .'新增可为空'],
+ 'VideoId' => ['description' => '视频ID', 'type' => 'string', 'required' => false, 'example' => '7036227ae3ab71efbb4a6733a68f0102'."\n"
+ .'不可为空'],
+ 'VideoName' => ['description' => '视频名称', 'type' => 'string', 'required' => false, 'example' => '123.mp4'."\n"
+ .'不可为空'],
+ 'In' => ['description' => '开始时间(妙)已经废弃', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'."\n"
+ .'不可为空'],
+ 'ContentInner' => ['description' => '口播文案分段', 'type' => 'string', 'required' => false, 'example' => '口播文案分段'."\n"
+ .'不可为空'],
+ 'InEx' => ['description' => '片段开始时间(毫秒)', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.45'],
+ 'Out' => ['description' => '结束时间(妙)已经废弃', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'."\n"
+ .'不可为空'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
+ ],
+ 'TimelineId' => ['description' => '时间线Id', 'type' => 'string', 'required' => false, 'example' => 'sdfjhks'."\n"
+ .'新增可为空'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID'."\n"
- ."\n\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['description' => '[百炼业务空间Id](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-az2gglkjauwnnhpq'],
+ ],
+ [
+ 'name' => 'AutoClips',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否开启自动调整能力', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回任务是否取消成功',
- 'description' => '返回任务是否取消成功',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'FB698445-61DA-5361-BF73-1C5F1157E888',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '唯一任务ID', 'type' => 'string', 'example' => '51e4efd1908242eb93ca9bbb7fc4359d'],
+ 'Message' => ['description' => '返回信息', 'type' => 'string', 'example' => '一些建议信息'],
+ ],
],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FB698445-61DA-5361-BF73-1C5F1157E888\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '取消异步任务',
- ],
- 'QueryAsyncTask' => [
- 'summary' => '查询已提交异步任务执行明细。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '编辑剪辑口播时间线',
+ 'summary' => '编辑剪辑任务的timeline',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-18T12:12:07.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncEditTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"51e4efd1908242eb93ca9bbb7fc4359d\\",\\n \\"Message\\": \\"一些建议信息\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'AsyncUploadTenderDoc' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '[工作空间ID](~~2782167~~)。', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'TenderDocName',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID'."\n"
- ."\n"
- .'>TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['description' => '招标书名字', 'type' => 'string', 'required' => false, 'example' => 'tender.pdf'],
+ ],
+ [
+ 'name' => 'FileKey',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文件osskey', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/materialDocument/1601892701595700_10169811/208757545922605632_yst-test_9eb7d7e1deb543d88e2d6f1c9df456ef.docx'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<AsyncTaskDO>',
- 'description' => 'PlainResult<AsyncTaskDO>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'CreateTime' => [
- 'title' => '创建日期',
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2021-07-25 14:34:33',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => '"12121"'."\n",
- ],
- 'TaskCode' => [
- 'title' => '任务标识,标识为哪一个任务',
- 'description' => '任务标识,标识为哪一个任务',
- 'type' => 'string',
- 'example' => 'MaterialDocumentUpload',
- ],
- 'TaskErrorMessage' => [
- 'title' => '任务执行错误消息',
- 'description' => '任务执行错误消息',
- 'type' => 'string',
- 'example' => 'error',
- ],
- 'TaskId' => [
- 'title' => '唯一任务ID',
- 'description' => '唯一任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskIntermediateResult' => [
- 'title' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续',
- 'description' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续',
- 'type' => 'string',
- 'example' => '"{}"',
- ],
- 'TaskName' => [
- 'title' => '任务名',
- 'description' => '任务名',
- 'type' => 'string',
- 'example' => '任务名称',
- ],
- 'TaskParam' => [
- 'title' => '任务执行输入参数,JSON格式',
- 'description' => '任务执行输入参数,JSON格式',
- 'type' => 'string',
- 'example' => '"{\\"fileKey\\":\\"oss://default/xxxx/xxxx/xxx\\",\\"fileName\\":\\"xxxxx.doc\\"}"',
- ],
- 'TaskProgressMessage' => [
- 'title' => '任务执行进度信息',
- 'description' => '任务执行进度信息',
- 'type' => 'string',
- 'example' => '"{}"',
- ],
- 'TaskResult' => [
- 'title' => '任务执行结果信息',
- 'description' => '任务执行结果信息',
- 'type' => 'string',
- 'example' => '"{}"',
- ],
- 'TaskRetryCount' => [
- 'title' => '任务已经重试的次数',
- 'description' => '任务已经重试的次数',
- 'type' => 'string',
- 'example' => '"3"',
- ],
- 'TaskStatus' => [
- 'title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'UpdateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2023-04-27 18:07:43',
- ],
- 'UpdateUser' => [
- 'title' => '更新者',
- 'description' => '更新者',
- 'type' => 'string',
- 'example' => '"12121"',
- ],
+ 'TaskId' => ['description' => '任务id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '867C4ABE-4381-5BC2-9810-5A5F334F71CF',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"2021-07-25 14:34:33\\",\\n \\"CreateUser\\": \\"\\\\\\"12121\\\\\\"\\\\n\\",\\n \\"TaskCode\\": \\"MaterialDocumentUpload\\",\\n \\"TaskErrorMessage\\": \\"error\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskIntermediateResult\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"TaskParam\\": \\"\\\\\\"{\\\\\\\\\\\\\\"fileKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://default/xxxx/xxxx/xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxxx.doc\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"TaskProgressMessage\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"TaskResult\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"TaskRetryCount\\": \\"\\\\\\"3\\\\\\"\\",\\n \\"TaskStatus\\": 1,\\n \\"UpdateTime\\": \\"2023-04-27 18:07:43\\",\\n \\"UpdateUser\\": \\"\\\\\\"12121\\\\\\"\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"867C4ABE-4381-5BC2-9810-5A5F334F71CF\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询异步任务明细',
- ],
- 'ListAsyncTasks' => [
- 'summary' => '获取异步任务列表。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '招标文档解析',
+ 'summary' => '上传招标书文件',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncUploadTenderDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
+ ],
+ 'AsyncUploadVideo' => [
+ 'summary' => '上传剪辑素材',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
+ 'name' => 'SourceVideos',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
+ 'description' => '剪辑素材结构',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '剪辑素材结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'VideoName' => ['description' => '视频名称'."\n", 'type' => 'string', 'required' => true, 'example' => '123.mp4', 'title' => '视频名称'."\n"],
+ 'VideoUrl' => [
+ 'description' => '视频地址。',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'http://123.mp4'."\n"
+ .'目前该接口只进行视频理解额和分析,并没有对文件进行转存。请保证视频地址在任务执行期间有效。',
+ 'title' => '视频地址。',
+ ],
+ 'VideoExtraInfo' => ['description' => '视频额外描述', 'type' => 'string', 'required' => false, 'example' => '视频中有一个房子', 'title' => '视频额外描述'],
+ ],
+ 'required' => false,
+ 'title' => '剪辑素材结构',
+ ],
'required' => true,
- 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public',
+ 'title' => '剪辑素材结构',
],
],
[
- 'name' => 'TaskName',
+ 'name' => 'AnlysisPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务名称精确查询',
- 'description' => '任务名称精确查询',
- 'type' => 'string',
- 'required' => false,
- 'example' => '任务名称',
- ],
+ 'schema' => ['description' => '视频理解prompt', 'type' => 'string', 'required' => false, 'example' => '重点理解视频中的风景信息', 'title' => '视频理解prompt'],
],
[
- 'name' => 'TaskCode',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务Code精确查询',
- 'description' => '任务Code精确查询',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MaterialDocumentUpload',
- ],
+ 'schema' => ['description' => '[百炼工作空间Id](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => '[百炼工作空间Id](~~2782167~~)'],
],
[
- 'name' => 'TaskType',
+ 'name' => 'ReferenceVideo',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务类型精确查询',
- 'description' => '任务类型精确查询',
- 'type' => 'string',
+ 'title' => '参考视频信息',
+ 'description' => '参考视频信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'VideoName' => ['description' => '参考视频名字', 'type' => 'string', 'required' => false, 'example' => 'refvideo.mp4', 'title' => '参考视频名字'],
+ 'VideoUrl' => ['description' => '视频地址。', 'type' => 'string', 'required' => false, 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/d71e_208334498220521996_51298e0a909d457693166eb883768c7a', 'title' => '视频地址。'],
+ 'VideoExtraInfo' => ['description' => '视频理解附加信息', 'type' => 'string', 'required' => false, 'example' => '手机cpu采用3纳米技术', 'title' => '视频理解附加信息'],
+ ],
'required' => false,
- 'example' => '暂无',
],
],
[
- 'name' => 'TaskStatus',
+ 'name' => 'SplitInterval',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务状态精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
- 'description' => '任务状态精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
- ],
- ],
+ 'schema' => ['description' => '视频理解镜头时间间隔', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '默认1', 'title' => '视频理解镜头时间间隔'],
],
[
- 'name' => 'TaskStatusList',
+ 'name' => 'VideoRoles',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '任务状态列表精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
- 'description' => '任务状态列表精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
+ 'title' => '角色人脸信息',
+ 'description' => '角色人脸信息',
'type' => 'array',
'items' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- '2',
- '3',
- '4',
- '5',
- '6',
+ 'title' => '角色名字',
+ 'description' => '角色名字',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleName' => ['title' => '角色名字', 'description' => '角色名字', 'type' => 'string', 'required' => false, 'example' => '李晓明'],
+ 'RoleInfo' => ['title' => '角色信息', 'description' => '角色信息', 'type' => 'string', 'required' => false, 'example' => '李晓明是一位警察'],
+ 'RoleUrls' => [
+ 'title' => '角色照片地址',
+ 'description' => '角色照片地址',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '角色图片文件信息',
+ 'description' => '角色图片文件信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'RoleFileName' => ['title' => '角色面部图片文件名字', 'description' => '角色面部图片文件名字', 'type' => 'string', 'required' => false, 'example' => '王小明.jpeg'],
+ 'RoleFileUrl' => ['title' => '角色面部图片公网地址', 'description' => '角色面部图片公网地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.jpeg'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
],
+ 'required' => false,
],
'required' => false,
],
],
[
- 'name' => 'TaskTypeList',
+ 'name' => 'FaceIdentitySimilarityMinScore',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '任务类型列表精确查询',
- 'description' => '任务类型列表精确查询',
- 'type' => 'array',
- 'items' => [
- 'title' => '任务分类',
- 'description' => '任务分类',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '人物识别相似度阈值', 'description' => '人物识别相似度阈值', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.7'],
],
[
- 'name' => 'CreateTimeStart',
+ 'name' => 'VideoShotFaceIdentityCount',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务创建时间 开始查询,格式为:YYYY-MM-DD HH:mm:ss',
- 'description' => '任务创建时间 开始查询,格式为:YYYY-MM-DD HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-02-19 07:28:11',
- ],
+ 'schema' => ['title' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量', 'description' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
[
- 'name' => 'CreateTimeEnd',
+ 'name' => 'RemoveSubtitle',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务创建时间 结束查询,格式为:YYYY-MM-DD HH:mm:ss',
- 'description' => '任务创建时间 结束查询,格式为:YYYY-MM-DD HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-18 02:00:00',
- ],
+ 'schema' => ['title' => '去除素材字幕', 'description' => '去除素材字幕', 'type' => 'boolean', 'required' => false],
],
[
- 'name' => 'Current',
+ 'name' => 'TaskName',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '任务名字', 'type' => 'string', 'required' => false, 'example' => 'task001', 'title' => '任务名称精确查询'],
],
[
- 'name' => 'Size',
+ 'name' => 'TaskType',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'type001', 'title' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)'],
+ ],
+ [
+ 'name' => 'AdaptiveThreshold',
+ 'in' => 'formData',
+ 'schema' => ['description' => '分镜阈值,越小分镜越敏感,取值1·10,默认是3', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '3.0', 'title' => '分镜阈值,越小分镜越敏感,取值 1·10,默认是 3'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageResult<AsyncTask>',
- 'description' => 'PageResult<AsyncTask>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Current' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'],
+ 'Code' => ['description' => '请求返回Code', 'type' => 'string', 'example' => 'successful', 'title' => '请求返回Code'],
'Data' => [
- 'description' => '返回的数据内容。',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务列表。',
- 'type' => 'object',
- 'properties' => [
- 'CreateTime' => [
- 'title' => '创建日期',
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2020-12-23 15:41:58',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => '1111',
- ],
- 'Id' => [
- 'description' => '任务主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskCode' => [
- 'title' => '任务标识,标识为哪一个任务',
- 'description' => '任务标识,标识为哪一个任务',
- 'type' => 'string',
- 'example' => 'MaterialDocumentUpload',
- ],
- 'TaskDefinition' => [
- 'title' => '可选的任务定义配置,JSON格式,这里的参数会覆盖系统配置的定义 详见:com.alibaba.tongyi.enterprise.aimiaobi.asynctask.entities.AsyncTaskDefinition',
- 'description' => '可选的任务定义配置,JSON格式,这里的参数会覆盖系统配置的定义',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'TaskEndTime' => [
- 'title' => '任务实际结束时间',
- 'description' => '任务实际结束时间',
- 'type' => 'string',
- 'example' => '2023-03-09 00:00:00',
- ],
- 'TaskErrorMessage' => [
- 'title' => '任务执行错误消息-供客户端查看',
- 'description' => '任务执行错误消息-供客户端查看',
- 'type' => 'string',
- 'example' => '系统内部错误',
- ],
- 'TaskExecuteTime' => [
- 'title' => '任务执行时间,只会轮询任务到期可执行的任务、为空表示立即执行',
- 'description' => '任务执行时间,只会轮询任务到期可执行的任务、为空表示立即执行',
- 'type' => 'string',
- 'example' => '2023-10-14 14:30:00',
- ],
- 'TaskId' => [
- 'title' => '唯一任务ID,作用等价于id',
- 'description' => '唯一任务ID,作用等价于id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskInnerErrorMessage' => [
- 'title' => '任务内部的执行错误消息,一些异常栈、内部线程栈等敏感信息打印在这里',
- 'description' => '任务内部的执行错误消息,一些异常栈、内部线程栈等敏感信息打印在这里',
- 'type' => 'string',
- 'example' => '系统错误',
- ],
- 'TaskIntermediateResult' => [
- 'title' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续',
- 'description' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'TaskName' => [
- 'title' => '任务名',
- 'description' => '任务名',
- 'type' => 'string',
- 'example' => '任务名',
- ],
- 'TaskParam' => [
- 'title' => '任务执行输入参数,JSON格式',
- 'description' => '任务执行输入参数,JSON格式',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'TaskProgressMessage' => [
- 'title' => '任务执行进度信息',
- 'description' => '任务执行进度信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'TaskResult' => [
- 'title' => '任务执行结果信息',
- 'description' => '任务执行结果信息',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'TaskRetryCount' => [
- 'title' => '任务已经重试的次数',
- 'description' => '任务已经重试的次数',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'TaskStartTime' => [
- 'title' => '任务实际开始时间',
- 'description' => '任务实际开始时间',
- 'type' => 'string',
- 'example' => '2023-03-20 10:53:00',
- ],
- 'TaskStatus' => [
- 'title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'TaskType' => [
- 'title' => '任务分类,多个任务分类一逗号分隔',
- 'description' => '任务分类,多个任务分类一逗号分隔',
- 'type' => 'string',
- 'example' => 'test',
- ],
- 'UpdateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2023-02-16 10:29:16',
- ],
- 'UpdateUser' => [
- 'title' => '更新者',
- 'description' => '更新者',
- 'type' => 'string',
- 'example' => '111',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => '任务ID'],
+ 'VideoInfos' => [
+ 'description' => '视频信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '视频信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'VideoId' => ['description' => '视频Id', 'type' => 'string', 'example' => '60616fad41b171f0bb4b4531948c0102', 'title' => '视频Id'],
+ 'VideoName' => ['description' => '视频名称'."\n", 'type' => 'string', 'example' => '123.mp4', 'title' => '视频名称'."\n"],
+ 'VideoUrl' => ['description' => '视频URL', 'type' => 'string', 'example' => 'http://123.mp4', 'title' => '视频URL'],
+ 'VideoExtraInfo' => ['description' => '视频额外信息', 'type' => 'string', 'example' => '视频中有一个房子', 'title' => '视频额外信息'],
+ ],
+ 'title' => '视频信息',
],
+ 'title' => '视频信息',
],
],
+ 'title' => '业务数据',
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE',
- ],
- 'Size' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => 'http状态码'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success', 'title' => '错误说明'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true', 'title' => '是否成功:true 成功,false 失败'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": \\"2020-12-23 15:41:58\\",\\n \\"CreateUser\\": \\"1111\\",\\n \\"Id\\": 1,\\n \\"TaskCode\\": \\"MaterialDocumentUpload\\",\\n \\"TaskDefinition\\": \\"{}\\",\\n \\"TaskEndTime\\": \\"2023-03-09 00:00:00\\",\\n \\"TaskErrorMessage\\": \\"系统内部错误\\",\\n \\"TaskExecuteTime\\": \\"2023-10-14 14:30:00\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskInnerErrorMessage\\": \\"系统错误\\",\\n \\"TaskIntermediateResult\\": \\"{}\\",\\n \\"TaskName\\": \\"任务名\\",\\n \\"TaskParam\\": \\"{}\\",\\n \\"TaskProgressMessage\\": \\"{}\\",\\n \\"TaskResult\\": \\"{}\\",\\n \\"TaskRetryCount\\": \\"1\\",\\n \\"TaskStartTime\\": \\"2023-03-20 10:53:00\\",\\n \\"TaskStatus\\": 1,\\n \\"TaskType\\": \\"test\\",\\n \\"UpdateTime\\": \\"2023-02-16 10:29:16\\",\\n \\"UpdateUser\\": \\"111\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 20\\n}","type":"json"}]',
- 'title' => '获取异步任务列表',
- ],
- 'CreateGeneralConfig' => [
- 'summary' => '通用配置-创建',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '异步上传视频剪辑素材',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncUploadVideo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"VideoInfos\\": [\\n {\\n \\"VideoId\\": \\"60616fad41b171f0bb4b4531948c0102\\",\\n \\"VideoName\\": \\"123.mp4\\",\\n \\"VideoUrl\\": \\"http://123.mp4\\",\\n \\"VideoExtraInfo\\": \\"视频中有一个房子\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'AsyncWritingBiddingDoc' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-',
- ],
+ 'schema' => ['description' => '[业务空间id](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'ConfigKey',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置项唯一标识,目前支持的:'."\n"
- .'- 妙搜-数据源-文本搜索阈值(double):searchGenerate.searchTextMinScore'."\n"
- .'- 妙搜-数据源-图片搜索阈值(double):searchGenerate.searchImageMinScore'."\n"
- .'- 妙搜-数据源-视频搜索阈值(double):searchGenerate.searchVideoMinScore'."\n"
- .'- 妙搜-数据源-音频搜索阈值(double):searchGenerate.searchAudioMinScore'."\n"
- .'- 妙搜-问答式搜索-通用-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaAgentPrompt'."\n"
- .'- 妙搜-问答式搜索-通用-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaAgentVlPrompt'."\n"
- .'- 妙搜-问答式搜索-深度-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaEnhanceAgentPrompt'."\n"
- .'- 妙搜-问答式搜索-深度-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaEnhanceAgentVlPrompt'."\n",
- 'description' => '配置项唯一标识,目前支持的:'."\n"
- .'- 妙搜-数据源-文本搜索阈值(double):searchGenerate.searchTextMinScore'."\n"
- .'- 妙搜-数据源-图片搜索阈值(double):searchGenerate.searchImageMinScore'."\n"
- .'- 妙搜-数据源-视频搜索阈值(double):searchGenerate.searchVideoMinScore'."\n"
- .'- 妙搜-数据源-音频搜索阈值(double):searchGenerate.searchAudioMinScore'."\n"
- .'- 妙搜-问答式搜索-通用-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaAgentPrompt'."\n"
- .'- 妙搜-问答式搜索-通用-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaAgentVlPrompt'."\n"
- .'- 妙搜-问答式搜索-深度-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaEnhanceAgentPrompt'."\n"
- .'- 妙搜-问答式搜索-深度-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaEnhanceAgentVlPrompt'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '任务唯一ID', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'],
],
[
- 'name' => 'ConfigValue',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置项值',
- 'description' => '配置项值',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '提示词', 'type' => 'string', 'required' => false, 'example' => '自定义观点的输入Prompt'],
+ ],
+ [
+ 'name' => 'CompanyKeyword',
+ 'in' => 'formData',
+ 'schema' => ['description' => '投标公司名称', 'type' => 'string', 'required' => false, 'example' => 'comany name'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'HttpStatusCode' => ['description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'title' => '结果',
- 'description' => '结果',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'ConfigKey' => [
- 'title' => '配置唯一标识',
- 'description' => '配置唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigValue' => [
- 'title' => '配置值',
- 'description' => '配置值',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigValueType' => [
- 'title' => '配置类型',
- 'description' => '配置类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigDesc' => [
- 'title' => '配置说明',
- 'description' => '配置说明',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xx\\"\\n }\\n}","type":"json"}]',
- 'title' => '通用配置-创建',
- ],
- 'ListGeneralConfigs' => [
- 'summary' => '通用配置-列表',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '标书写作',
+ 'summary' => '标书写作接口',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncWritingBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
+ ],
+ 'BindPptArtifact' => [
+ 'summary' => '绑定PPT作品信息',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xgpt3m25qdosdjr3'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数',
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => '85da2bfe-6f05-41af-9841-d73c5bbf43a2'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'ArtifactId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页:默认1',
- 'description' => '当前页:默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '作品ID', 'description' => '作品ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12342'],
+ ],
+ [
+ 'name' => 'ExternalUserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '第三方传入的用户ID', 'type' => 'string', 'example' => 'abc'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'title' => '查询结果',
- 'description' => '查询结果',
- 'type' => 'array',
- 'items' => [
- 'title' => '查询结果',
- 'description' => '查询结果',
- 'type' => 'object',
- 'properties' => [
- 'ConfigKey' => [
- 'title' => '配置项唯一标识',
- 'description' => '配置项唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ConfigValue' => [
- 'title' => '配置值',
- 'description' => '配置值',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ConfigValueType' => [
- 'title' => '配置项类型',
- 'description' => '配置项类型',
- 'type' => 'string',
- 'example' => 'CustomSemanticSearch',
- ],
- 'ConfigDesc' => [
- 'title' => '配置项说明',
- 'description' => '配置项说明',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '110f8401-e5ba-42db-addb-4f70196000c1'],
],
],
- 'PageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TotalCount' => [
- 'title' => '总条数',
- 'description' => '总条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageSize' => [
- 'title' => '每页条数',
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ConfigKey\\": \\"xxx\\",\\n \\"ConfigValue\\": \\"xxx\\",\\n \\"ConfigValueType\\": \\"CustomSemanticSearch\\",\\n \\"ConfigDesc\\": \\"xxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
- 'title' => '通用配置-列表',
- ],
- 'GetGeneralConfig' => [
- 'summary' => '通用配置-查询。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '绑定PPT作品信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:BindPptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"110f8401-e5ba-42db-addb-4f70196000c1\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'CancelAsyncTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
],
[
- 'name' => 'ConfigKey',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置唯一标识',
- 'description' => '配置唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID'."\n"
+ ."\n\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => '返回任务是否取消成功',
+ 'description' => '返回任务是否取消成功',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Data' => [
- 'title' => '结果',
- 'description' => '结果',
- 'type' => 'object',
- 'properties' => [
- 'ConfigKey' => [
- 'title' => '配置唯一标识',
- 'description' => '配置唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigValue' => [
- 'title' => '配置值',
- 'description' => '配置值',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigValueType' => [
- 'title' => '配置值类型',
- 'description' => '配置值类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigDesc' => [
- 'title' => '配置描述',
- 'description' => '配置描述',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'true'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'FB698445-61DA-5361-BF73-1C5F1157E888'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消异步任务',
+ 'summary' => '取消已提交,尚未执行完成的异步任务。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xx\\"\\n }\\n}","type":"json"}]',
- 'title' => '通用配置-详情',
- ],
- 'UpdateGeneralConfig' => [
- 'summary' => '通用配置-修改。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAsyncTask'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CancelAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"FB698445-61DA-5361-BF73-1C5F1157E888\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'CancelAuditTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3447,512 +1861,223 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'ContentAuditTaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '审核任务ID(任务ID与文章ID二选一)', 'description' => '审核任务ID(任务ID与文章ID二选一)', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'ConfigKey',
+ 'name' => 'ArticleId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置项唯一标识',
- 'description' => '配置项唯一标识,支持的配置:'."\n"
- .'- 妙搜-数据源-文本搜索阈值(double):searchGenerate.searchTextMinScore'."\n"
- .'- 妙搜-数据源-图片搜索阈值(double):searchGenerate.searchImageMinScore'."\n"
- .'- 妙搜-数据源-视频搜索阈值(double):searchGenerate.searchVideoMinScore'."\n"
- .'- 妙搜-数据源-音频搜索阈值(double):searchGenerate.searchAudioMinScore'."\n"
- .'- 妙搜-问答式搜索-通用-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaAgentPrompt'."\n"
- .'- 妙搜-问答式搜索-通用-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaAgentVlPrompt'."\n"
- .'- 妙搜-问答式搜索-深度-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaEnhanceAgentPrompt'."\n"
- .'- 妙搜-问答式搜索-深度-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaEnhanceAgentVlPrompt',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx',
- ],
+ 'schema' => ['title' => '文章ID(任务ID与文章ID二选一)', 'description' => '文章ID(任务ID与文章ID二选一)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'ConfigValue',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置值',
- 'description' => '配置值',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '配置项唯一标识',
- 'description' => '配置项唯一标识',
- 'type' => 'object',
- 'properties' => [
- 'ConfigKey' => [
- 'title' => '配置值',
- 'description' => '配置唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigValue' => [
- 'title' => '创建者',
- 'description' => '配置值',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ConfigValueType' => [
- 'title' => '配置值类型',
- 'description' => '配置值类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ConfigDesc' => [
- 'title' => '配置项说明',
- 'description' => '配置项说明',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => ['title' => '是否取消成功', 'description' => '是否取消成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xxx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xxx\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '通用配置-修改',
- ],
- 'DeleteGeneralConfig' => [
- 'summary' => '通用配置-删除',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消审核任务',
+ 'summary' => '取消审核任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CancelAuditTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'CancelDeepWriteTask' => [
+ 'summary' => '取消深度写作任务。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxxx'],
],
[
- 'name' => 'ConfigKey',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置唯一标识',
- 'description' => '配置唯一标识',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'xbabac91-fdad-44d6-95ce-******'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xbabac91-fdad-44d6-95ce-******'],
+ 'Input' => ['title' => '用户的问题', 'description' => '用户的问题', 'type' => 'string', 'example' => '北京2025年新能源汽车发展趋势'],
+ 'Status' => [
+ 'title' => '任务状态',
+ 'description' => '任务状态',
+ 'type' => 'string',
+ 'enumValueTitles' => ['in_progress' => '运行中', 'queued' => '排队中', 'cancelled' => '已取消', 'completed' => '已完成', 'failed' => '失败'],
+ 'example' => 'cancelled',
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '通用配置-删除',
- ],
- 'RunAiHelperWriting' => [
- 'summary' => '妙笔:AI助手写作',
- 'path' => '/quanmiao/aimiaobi/runAiHelperWriting',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '取消深度写作任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CancelDeepWriteTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xbabac91-fdad-44d6-95ce-******\\",\\n \\"Input\\": \\"北京2025年新能源汽车发展趋势\\",\\n \\"Status\\": \\"cancelled\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ClearIntervenes' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxx',
- ],
- ],
- [
- 'name' => 'WritingScene',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '写作场景',
- 'description' => '写作场景:government(政务)、media(传媒)、market(营销)、office(办公)、custom(自定义)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'media',
- ],
- ],
- [
- 'name' => 'WritingStyle',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '写作文体',
- 'description' => '写作文体唯一标识KEY,可通过[ListWritingStyles](~~2922609~~)接口获取对应写作场景下的文体列表',
- 'type' => 'string',
- 'required' => true,
- 'example' => '通知',
- ],
- ],
- [
- 'name' => 'Prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '提示词,需要帮写的主题',
- 'description' => '提示词,需要帮写的主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '请帮我写一篇关于人工智能发展趋势的文章',
- ],
- ],
- [
- 'name' => 'PromptMode',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '提示词模式,如:PE:高级模式,Template:模板模式',
- 'description' => '提示词模式,如:PE:高级模式,Template:模板模式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Template',
- ],
- ],
- [
- 'name' => 'DistributeWriting',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否分步骤写作文体',
- 'description' => '是否分步骤写作文体',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'WritingParams',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '当前文体的表单的写作参数,键值对形式',
- 'description' => '上一次表单的写作参数,键值对形式',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'title' => '写作参数KEY VALUE',
- 'description' => '写作参数KEY VALUE',
- 'type' => 'string',
- 'example' => '{"topic":"写作主题"}',
- ],
- 'example' => '{"wordCount": "1000", "tone": "formal"}',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<OperationResult>',
+ 'description' => 'PlainResult<OperationResult>',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => 'SSE响应头信息',
- 'description' => 'SSE响应头信息',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'InvalidParameter',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '参数错误',
- ],
- 'Event' => [
- 'title' => '事件类型',
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'result-generated',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => 'session-xxxxx',
- ],
- 'StatusCode' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'task-xxxxx',
- ],
- 'TraceId' => [
- 'title' => '链路追踪ID',
- 'description' => '链路追踪ID',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应载荷',
- 'description' => '响应载荷',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'title' => '输出内容',
- 'description' => '输出内容',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '生成文本',
- 'description' => '生成文本',
- 'type' => 'string',
- 'example' => '人工智能正在深刻改变我们的生活...',
- ],
- 'WritingParams' => [
- 'title' => 'AI帮写的写作参数',
- 'description' => 'AI帮写的写作参数',
- 'type' => 'object',
- 'additionalProperties' => [
- 'title' => 'KEY VALUE形式的键值对',
- 'description' => 'KEY VALUE形式的键值对',
- 'type' => 'string',
- 'example' => '{"topic":"写作主题xxx"}',
- ],
- 'example' => '{"wordCount": "1000"}',
- ],
- ],
- ],
- 'Usage' => [
- 'title' => 'Token使用量',
- 'description' => 'Token使用量',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'title' => '输入Token数',
- 'description' => '输入Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '256',
- ],
- 'OutputTokens' => [
- 'title' => '输出Token数',
- 'description' => '输出Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1024',
- ],
- 'TotalTokens' => [
- 'title' => '总Token数',
- 'description' => '总Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1280',
- ],
- ],
+ 'FailIdList' => [
+ 'title' => '失败的索引id列表',
+ 'description' => '失败的索引id列表',
+ 'type' => 'array',
+ 'items' => ['description' => '失败的干预项Id', 'type' => 'string', 'example' => '"1234"'],
],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Code' => ['description' => '干预服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'HttpStatusCode' => [
- 'title' => 'HTTP状态码',
- 'description' => 'HTTP状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Code' => [
- 'title' => '业务状态码',
- 'description' => '业务状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Message' => [
- 'title' => '返回信息',
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ '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'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '清除所有干预项',
+ 'summary' => '清除所有干预内容。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"参数错误\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"SessionId\\": \\"session-xxxxx\\",\\n \\"StatusCode\\": 200,\\n \\"TaskId\\": \\"task-xxxxx\\",\\n \\"TraceId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"人工智能正在深刻改变我们的生活...\\",\\n \\"WritingParams\\": {\\n \\"key\\": \\"{\\\\\\"topic\\\\\\":\\\\\\"写作主题xxx\\\\\\"}\\"\\n }\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 256,\\n \\"OutputTokens\\": 1024,\\n \\"TotalTokens\\": 1280\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => 'AI帮写',
- 'requestParamsDescription' => '## 示例数据'."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "WorkspaceId": "llm-xxx",'."\n"
- .' "WritingScene": "office",'."\n"
- .' "WritingStyle": "speech",'."\n"
- .' "Prompt": "关于“人工智能伦理与社会影响”主题的演讲稿"'."\n"
- .'}'."\n"
- .'```',
- ],
- 'RunWritingV2' => [
- 'summary' => '智能写作。',
- 'path' => '/quanmiao/aimiaobi/runWritingV2',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ClearIntervenes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"\\\\\\"1234\\\\\\"\\"\\n ],\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ConfirmAndPostProcessAuditNote' => [
+ 'summary' => '是否将本次提交自定义规则库得到的解析结果用于审核任务。由于解析结果可能不满足用户需求,因此我们为您提供了该接口用于二次确认。如果对提交的规则库解析满意,则可以直接将本次提交任务的 TaskId 作为入参,系统会对您上传的规则库做后处理,使它可以被用于审核。反之,您可以重新调用 SubmitAuditNote 接口上传修改之后的规则库。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3960,1421 +2085,709 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,多轮对话可复用同一轮任务ID',
- 'description' => '任务唯一ID,多轮对话可复用同一轮任务ID'."\n"
- ."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。', 'description' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。', 'type' => 'string', 'required' => true, 'example' => 'xxx_Default_1241541251241'],
],
- [
- 'name' => 'SessionId',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '单轮对话的ID',
- 'description' => '单轮对话的ID(已过期,不推荐传递)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '确认使用该解析结果后得到的任务 ID。实际上与入参一致,在这里返回是为了方便您取值。', 'description' => '确认使用该解析结果后得到的任务 ID。实际上与入参一致,在这里返回是为了方便您取值。', 'type' => 'string', 'example' => '33'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '确认提交规则库用于审核',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'WritingScene',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '写作场景(government:政务、media:传媒、market:营销,office:办公,custom:自定义)',
- 'description' => '写作场景(government:政务、media:传媒、market:营销,office:办公,custom:自定义)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'media',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ConfirmAndPostProcessAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"33\\"\\n}","type":"json"}]',
+ ],
+ 'CreateDataPermissions' => [
+ 'summary' => '权限-批量添加:'."\n"
+ .'- 数据集权限:',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'WritingStyle',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '写作文体',
- 'description' => '写作文体,具体文体列表请参考:[ListWritingStyles](~~2922609~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新闻评论',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'DistributeWriting',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否为分步骤写作',
- 'description' => '是否为分步骤写作,请参考 接口请求示例 的 分步骤 参数说明。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'PromptMode',
+ 'name' => 'DataType',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板类型(Template:模板模式, PE:高级PE模式)',
- 'description' => '模板类型:Template(模板模式), PE(高级PE模式)'."\n"
- ."\n"
- .'1. 当 PromptMode为空时,传Prompt,推荐格式为:写作主题+写作篇幅+写作要求+禁止事项'."\n"
- ."\n"
- .'2. 当 PromptMode=Template时,需要传 WritingParams(字典类型,key、value都是字符串),writingParams 表单定义参考:[ListWritingStyles](~~2922609~~)接口中的 .Data.TemplateDefine[].Fields'."\n"
- ."\n"
- .'3. 当 PromptMode=PE,需要传WritingParams,且固定传两个字段'."\n"
- .' 1. topic: 话题,必填。需要写的主题内容'."\n"
- .' 2. prompt: 其他自定义提示词,选填。其他写作要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Template',
- ],
+ 'schema' => ['title' => '权限类型:目前支持:dataset', 'description' => '权限类型:目前支持:dataset', 'type' => 'string', 'required' => true, 'example' => 'dataset'],
],
[
- 'name' => 'Step',
+ 'name' => 'DataId',
'in' => 'formData',
- 'schema' => [
- 'title' => '分步骤写作步骤:'."\n"
- .'OutlineGenerate:大纲生成'."\n"
- .'OutlineSearch:写完大纲之后,根据大纲内容检索'."\n"
- .'Writing:写作',
- 'description' => '分步骤写作步骤:'."\n"
- .'- OutlineGenerate: 大纲生成'."\n"
- .'- Writing: 写作'."\n"
- ."\n"
- .'在分步骤写作场景中(DistributeWriting=true) 默认 先写大纲、后根据大纲写作。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Writing',
- ],
+ 'schema' => ['title' => '权限唯一标识:', 'description' => '权限唯一标识:', 'type' => 'string', 'required' => true, 'example' => 'SystemSearch.QuarkCommonNews'],
],
[
- 'name' => 'Articles',
+ 'name' => 'PermissionUserInfos',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '引用的文章',
- 'description' => '引用的文章(注意 传递此参数后, 联网检索将不会进行,影响:SearchSources、 SearchSources 参数)',
+ 'title' => '分配权限的用户',
+ 'description' => '分配权限的用户',
'type' => 'array',
'items' => [
- 'title' => '文章对象',
- 'description' => '文章对象',
+ 'title' => '用户',
+ 'description' => '用户',
'type' => 'object',
'properties' => [
- 'Title' => [
- 'title' => '文章标题',
- 'description' => '文章标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- ],
- 'Content' => [
- 'title' => '文章内容',
- 'description' => '文章内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章内容',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- 'Source' => [
- 'title' => '文章来源',
- 'description' => '文章来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新华社',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源',
- 'description' => '搜索信源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-11-25 14:25:59',
- ],
+ 'PermissionUserId' => ['title' => '用户id:账号aliuid', 'description' => '用户id:'."\n"
+ .'- ram子账号:账号aliuid'."\n"
+ .'- 角色用户:AssumedRoleUser${roleId}', 'type' => 'string', 'required' => true, 'example' => '1'],
+ 'PermissionUsername' => ['title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
'required' => false,
],
- 'required' => false,
+ 'required' => true,
],
],
- [
- 'name' => 'GcNumberSizeTag',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => '文章篇幅(短篇、中篇、长篇。或者 2K字、3K字、4K字等等长度描述)',
- 'description' => '文章篇幅描述(300字左右、600字左右、1000字左右、2000字左右等)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2000字左右',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '权限-批量添加',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'GcNumberSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '写作的篇数(多篇按照不同的sessionId同时返回)',
- 'description' => '写作的篇数(多篇按照不同的sessionId同时返回)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateDataPermissions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'CreateDataset' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'Language',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文章输出语言(en:英文,zh:中文)',
- 'description' => '文章输出语言'."\n"
- ."\n"
- .'- en:英文'."\n"
- .'- zh:中文'."\n"
- .'- 或者其他自定义的输出语言要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'Keywords',
+ 'name' => 'DatasetType',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '关键词列表(会参与到检索与写作)',
- 'description' => '关键词列表(会参与到检索与写作)',
- 'type' => 'array',
- 'items' => [
- 'title' => '关键词(会参与到检索与写作)',
- 'description' => '关键词(会参与到检索与写作)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关键词',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '数据集类型', 'description' => '数据集类型:'."\n"
+ .'- CustomSemanticSearch:自建语义索引(默认),用户上传文档构建数据集'."\n"
+ .'- ThirdSearch:三方搜索源(api),配置用户自己的搜索api', 'type' => 'string', 'required' => false, 'example' => 'CustomSemanticSearch', 'default' => 'CustomSemanticSearch'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'schema' => [
- 'title' => '其他写作参数(prompt 和 writingParams 二选一)',
- 'description' => '写作提示词(prompt 和 writingParams 二选一,详情请参考PromptMode字段说明)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '提示词',
- ],
+ 'schema' => ['title' => '数据集名称,全局唯一', 'description' => '数据集名称,全局唯一', 'type' => 'string', 'required' => true, 'example' => 'businessDataset'],
],
[
- 'name' => 'WritingParams',
+ 'name' => 'DatasetDescription',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '写作提示词(prompt 和 writingParams 二选一)',
- 'description' => '模板写作参数(字典结构,key value 都是字符串)(prompt 和 writingParams 二选一,详情请参考PromptMode字段说明)',
- 'type' => 'object',
- 'required' => false,
- 'additionalProperties' => [
- 'type' => 'string',
- 'example' => '模板写作参数',
- 'description' => '模板写作参数',
- ],
- ],
+ 'schema' => ['title' => '数据集描述', 'description' => '数据集描述:控制台展示名称,建议传入业务可读的名称', 'type' => 'string', 'required' => false, 'example' => '企业知识库'],
],
[
- 'name' => 'Outlines',
+ 'name' => 'SearchDatasetEnable',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关:'."\n"
+ .'- 0:全部关闭'."\n"
+ .'- 1:仅妙搜可见'."\n"
+ .'- 2:仅妙笔可见'."\n"
+ .'- 3:妙搜&妙笔均可见 (默认)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'default' => '3'],
+ ],
+ [
+ 'name' => 'DatasetConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '大纲列表(分步骤接口使用)',
- 'description' => '大纲列表(分步骤接口使用,已过时,推荐使用新版分步骤写作的:OutlineList)',
- 'type' => 'array',
- 'items' => [
- 'title' => '大纲对象',
- 'description' => '大纲对象',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'required' => false,
- 'example' => '大纲',
- ],
- 'Articles' => [
- 'title' => '大纲重点参考的文章列表',
- 'description' => '大纲重点参考的文章列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '大纲重点参考的文章',
- 'description' => '大纲重点参考的文章',
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标题',
- ],
- 'Content' => [
- 'title' => '正文内容',
- 'description' => '正文内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '正文内容',
+ 'title' => '数据集配置',
+ 'description' => '数据集搜索配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'SearchSourceConfigs' => [
+ 'title' => '三方搜索:api定义',
+ 'description' => '三方搜索:api定义',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '三方搜索:api定义',
+ 'type' => 'object',
+ 'properties' => [
+ 'DemoQuery' => ['title' => '可以搜索到的关键词,用来验证是否可用', 'description' => '可以搜索到的关键词,用来验证是否可用', 'type' => 'string', 'required' => false, 'example' => '可以搜索到的关键词,用来验证是否可用'],
+ 'Size' => ['title' => '默认请求、响应数据条数限制', 'description' => '默认请求、响应数据条数限制', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'SearchSourceRequestConfig' => [
+ 'title' => 'api请求配置',
+ 'description' => 'api请求配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => 'api地址', 'description' => 'api地址', 'type' => 'string', 'required' => false, 'example' => 'api地址'],
+ 'Method' => ['title' => '请求方式', 'description' => '请求方式', 'type' => 'string', 'required' => false, 'example' => '请求方式'],
+ 'ConnectTimeout' => ['title' => '连接超时时间:单位毫秒', 'description' => '连接超时时间:单位毫秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
+ 'SocketTimeout' => ['title' => '读超时时间:单位毫秒', 'description' => '读超时时间:单位毫秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
+ 'Headers' => [
+ 'description' => 'http请求头',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'http请求头',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => '参数名称'],
+ 'ValueType' => ['title' => '参数值数据类型: 默认string', 'description' => '参数值数据类型:默认string', 'type' => 'string', 'required' => false, 'example' => '参数值数据类型:默认string'],
+ 'ValueFormat' => ['title' => 'valueType = time 时有效', 'description' => 'valueType = time 时有效', 'type' => 'string', 'required' => false, 'example' => 'valueType = time 时有效'],
+ 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '参数值'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'Params' => [
+ 'title' => '请求path参数',
+ 'description' => '请求path参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => '参数名称'],
+ 'ValueType' => ['title' => '参数值数据类型: 默认string', 'description' => '参数值数据类型:默认string', 'type' => 'string', 'required' => false, 'example' => '参数值数据类型:默认string'],
+ 'ValueFormat' => ['title' => 'valueType = time 时有效', 'description' => 'valueType = time 时有效', 'type' => 'string', 'required' => false, 'example' => 'valueType = time 时有效'],
+ 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '参数值'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ 'PathParamsEnable' => ['title' => '是否开启pathParam', 'description' => '是否开启pathParam', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Body' => ['title' => '请求body', 'description' => '请求body', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章URL',
+ 'required' => false,
+ ],
+ 'SearchSourceResponseConfig' => [
+ 'title' => 'api响应配置',
+ 'description' => 'api响应配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'JqNodes' => [
+ 'title' => '节点配置',
+ 'description' => '节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'required' => false, 'example' => '节点key'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => '节点数据类型:string number list object base', 'type' => 'string', 'required' => false, 'example' => '节点数据类型:string number list object base'],
+ 'Path' => ['title' => '节点路径', 'description' => '节点路径', 'type' => 'string', 'required' => false, 'example' => '节点路径'],
+ 'JqNodes' => [
+ 'title' => '子节点配置',
+ 'description' => '子节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'required' => false, 'example' => 'title'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => 'type类型', 'type' => 'string', 'required' => false, 'example' => 'string'],
+ 'Path' => ['title' => '节点路径', 'description' => '路径。', 'type' => 'string', 'required' => false, 'example' => '节点路径'],
+ 'JqNodes' => [
+ 'description' => '子节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'required' => false, 'example' => 'title'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => 'type类型', 'type' => 'string', 'required' => false, 'example' => 'string'],
+ 'Path' => ['title' => '节点路径', 'description' => '节点路径', 'type' => 'string', 'required' => false, 'example' => '节点路径'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
],
+ 'required' => false,
],
- 'required' => false,
],
'required' => false,
],
+ 'required' => false,
],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Summarization',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '摘编对象列表(分步骤接口使用)',
- 'description' => '摘编对象列表(分步骤接口使用)',
- 'type' => 'array',
- 'items' => [
- 'title' => '摘编对象',
- 'description' => '摘编对象',
- 'type' => 'object',
- 'properties' => [
- 'Event' => [
- 'title' => '事件名称',
- 'description' => '事件名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '事件名称'."\n"
- ."\n",
- ],
- 'Message' => [
- 'title' => '事件摘编',
- 'description' => '事件摘编',
- 'type' => 'string',
- 'required' => false,
- 'example' => '事件摘编'."\n"
- ."\n",
+ 'SearchSourceConfig' => [
+ 'description' => '数据集配置项',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagSearchEnable' => ['description' => '标签是否参与搜索:默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'TagGenerateEnable' => ['description' => '标签是否参与生成:默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'MetadataKeyValueSearchEnable' => ['description' => 'metadata-keyValue部分是否参与搜索:默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'MetadataKeyValueGenerateEnable' => ['description' => 'metadata-keyValue部分是否参与生成:默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
+ 'required' => false,
],
- 'required' => false,
],
'required' => false,
],
],
[
- 'name' => 'MiniDocs',
+ 'name' => 'DocumentHandleConfig',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '文章片段列表',
- 'description' => '文章片段列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '文章片段对象',
- 'description' => '文章片段对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '片段内容',
- 'description' => '片段内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '片段内容'."\n"
- ."\n",
- ],
- 'Star' => [
- 'title' => '是否重点考虑该片段',
- 'description' => '是否重点考虑该片段',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Index' => [
- 'title' => '文章片段在引用文章中的索引',
- 'description' => '文章片段在引用文章中的索引',
- 'type' => 'string',
- 'required' => false,
- 'example' => '索引',
- ],
- ],
- 'required' => false,
+ 'title' => '数据集索引配置',
+ 'description' => '数据集索引配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'DisableHandleMultimodalMedia' => ['title' => '禁用多媒体文件处理逻辑,默认为false', 'description' => '禁用多媒体文件处理逻辑:'."\n"
+ .'- true:禁用多模态(图片、视频)索引,仅索引和搜索文本'."\n"
+ .'- false:支持多模态(文本、图片、视频)索引,同时开通视频云并在系统管理中做了授权才正式生效,仅设置false,这里识别到未授权会自动跳过图片、视频索引(默认)', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
'required' => false,
],
],
[
- 'name' => 'UseSearch',
+ 'name' => 'InvokeType',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否使用搜索',
- 'description' => '是否使用联网检索。(默认不检索,true 则会 走 系统自带的 联网检索)',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '调用方式:目前仅支持值portal,标识控制台调用。'."\n"
+ .'- 空时:当DatasetType= ThirdSearch,datasetConfig.SearchSourceConfigs(三方api定义)必传。'."\n"
+ .'- portal时:当DatasetType= ThirdSearch,后台会默认初始化一个SearchSourceConfigs(三方apidemo)示例,供参考。', 'description' => '调用方式:目前仅支持值portal,标识控制台调用。'."\n"
+ .'- 空时:当DatasetType= ThirdSearch,datasetConfig.SearchSourceConfigs(三方api定义)必传。'."\n"
+ .'- portal时:当DatasetType= ThirdSearch,后台会默认初始化一个SearchSourceConfigs(三方apidemo)示例,供参考。', 'type' => 'string', 'required' => false, 'example' => 'portal'],
],
[
- 'name' => 'SearchSources',
+ 'name' => 'AccessLevel',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['type' => 'string', 'example' => 'private'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '使用指定的搜索源列表',
- 'description' => '使用指定的搜索源列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '搜索源对象',
- 'description' => '搜索源对象',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索',
- 'description' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SystemSearch',
- ],
- 'Name' => [
- 'title' => '搜索源描述',
- 'description' => '搜索源描述(已过时,不推荐使用, 传递后不会生效)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '互联网搜索',
- ],
- 'DatasetName' => [
- 'title' => '数据源唯一标识',
- 'description' => '数据源唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时回见', 'type' => 'string', 'example' => '2024-11-12 21:46:24'],
+ 'DatasetType' => ['title' => '数据集类型', 'description' => '数据集类型', 'type' => 'string', 'example' => 'CustomSemanticSearch'],
+ 'DatasetName' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'example' => 'xxx'],
+ 'DatasetDescription' => ['title' => '数据集显示名称', 'description' => '数据集显示名称', 'type' => 'string', 'example' => 'xxx'],
+ 'SearchDatasetEnable' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
- 'required' => false,
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
- 'required' => false,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-创建',
+ 'summary' => '数据源管理-创建。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-06T08:40:24.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'OutlineList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '大纲列表(新版分大纲写作)',
- 'description' => '大纲列表(新版分大纲写作)',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲',
- 'required' => false,
- '$ref' => '#/components/schemas/WritingOutline',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'CreateGeneralConfig' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'SourceTraceMethod',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '溯源方式(目前仅支持modelSourceTrace)'."\n"
- .' modelSourceTrace:在最后输出的正文中,让模型在 各个片段的尾部输出引用标记。以 [[n]]。索引从1开始。',
- 'description' => '溯源方式(目前仅支持modelSourceTrace)'."\n"
- .' modelSourceTrace:在最后输出的正文中,让模型在 各个片段的尾部输出引用标记。以 [[n]]。索引从1开始。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'modelSourceTrace',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-'],
+ ],
+ [
+ 'name' => 'ConfigKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '配置项唯一标识,目前支持的:'."\n"
+ .'- 妙搜-数据源-文本搜索阈值(double):searchGenerate.searchTextMinScore'."\n"
+ .'- 妙搜-数据源-图片搜索阈值(double):searchGenerate.searchImageMinScore'."\n"
+ .'- 妙搜-数据源-视频搜索阈值(double):searchGenerate.searchVideoMinScore'."\n"
+ .'- 妙搜-数据源-音频搜索阈值(double):searchGenerate.searchAudioMinScore'."\n"
+ .'- 妙搜-问答式搜索-通用-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaAgentPrompt'."\n"
+ .'- 妙搜-问答式搜索-通用-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaAgentVlPrompt'."\n"
+ .'- 妙搜-问答式搜索-深度-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaEnhanceAgentPrompt'."\n"
+ .'- 妙搜-问答式搜索-深度-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaEnhanceAgentVlPrompt'."\n", 'description' => '配置项唯一标识,目前支持的:'."\n"
+ .'- 妙搜-数据源-文本搜索阈值(double):searchGenerate.searchTextMinScore'."\n"
+ .'- 妙搜-数据源-图片搜索阈值(double):searchGenerate.searchImageMinScore'."\n"
+ .'- 妙搜-数据源-视频搜索阈值(double):searchGenerate.searchVideoMinScore'."\n"
+ .'- 妙搜-数据源-音频搜索阈值(double):searchGenerate.searchAudioMinScore'."\n"
+ .'- 妙搜-问答式搜索-通用-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaAgentPrompt'."\n"
+ .'- 妙搜-问答式搜索-通用-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaAgentVlPrompt'."\n"
+ .'- 妙搜-问答式搜索-深度-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaEnhanceAgentPrompt'."\n"
+ .'- 妙搜-问答式搜索-深度-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaEnhanceAgentVlPrompt'."\n", 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'ConfigValue',
+ 'in' => 'formData',
+ 'schema' => ['title' => '配置项值', 'description' => '配置项值', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'BaseLlmResponse',
- 'description' => 'BaseLlmResponse',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'StatusCode' => [
- 'title' => 'http响应码',
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
+ 'Data' => [
+ 'title' => '结果',
+ 'description' => '结果',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '参照文章',
- 'description' => '参照文章',
- 'type' => 'array',
- 'items' => [
- 'description' => '参照文章',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => '98229f6001cf4deeb1668191d4eccc75',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-08-28 11:38:28',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- ],
- ],
- ],
- 'MiniDoc' => [
- 'title' => '文章精排之后的片段列表',
- 'description' => '文章精排之后的片段列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '文章精排之后的片段'."\n"
- .' * ',
- 'description' => '文章精排之后的片段'."\n"
- .' * ',
- 'type' => 'string',
- 'example' => '文章精排之后的片段',
- ],
- 'example' => '文章精排之后的片段',
- ],
- 'SearchQuery' => [
- 'title' => 'query改写结果',
- 'description' => 'query改写结果',
- 'type' => 'string',
- 'example' => '大模型改变世界',
- ],
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- 'Outlines' => [
- 'title' => '大纲列表(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)',
- 'description' => '大纲列表(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)',
- 'type' => 'array',
- 'items' => [
- 'title' => '',
- 'description' => '大纲',
- '$ref' => '#/components/schemas/WritingOutline',
- ],
- ],
- 'Title' => [
- 'title' => '文章标题(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)',
- 'description' => '文章标题(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'SearchResult' => [
- 'title' => '检索结果(分步骤大纲生成场景下writingStyle=outlineWriting。step=OutlineSearch 时返回该字段)',
- 'description' => '检索结果(分步骤大纲生成场景下writingStyle=outlineWriting。step=OutlineSearch 时返回该字段)',
- '$ref' => '#/components/schemas/OutlineSearchResult',
- ],
- 'GenerateTraceability' => [
- 'title' => '溯源对象(当传入 该 modelSourceTrace参数 后会返回该字段)',
- 'description' => '溯源对象(当传入 该 modelSourceTrace参数 后会返回该字段)',
- '$ref' => '#/components/schemas/GenerateTraceability',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '78',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '34',
- ],
- 'TokenMap' => [
- 'description' => 'token消耗明细',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '44',
- 'description' => 'token消耗明细',
- ],
- ],
- 'TotalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '38',
- ],
- ],
- ],
+ 'ConfigKey' => ['title' => '配置唯一标识', 'description' => '配置唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigValue' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigValueType' => ['title' => '配置类型', 'description' => '配置类型', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigDesc' => ['title' => '配置说明', 'description' => '配置说明', 'type' => 'string', 'example' => 'xx'],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'End' => [
- 'description' => '响应包是否结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通用配置-创建',
+ 'summary' => '通用配置-创建',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"98229f6001cf4deeb1668191d4eccc75\\",\\n \\"PubTime\\": \\"2024-08-28 11:38:28\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"MiniDoc\\": [\\n \\"文章精排之后的片段\\"\\n ],\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\",\\n \\"Outlines\\": [\\n {\\n \\"WritingTips\\": \\"\\",\\n \\"OutlineId\\": \\"\\",\\n \\"Outline\\": \\"\\",\\n \\"SearchKeyWordList\\": [\\n \\"\\"\\n ],\\n \\"WordCount\\": \\"\\",\\n \\"Articles\\": [\\n {\\n \\"Url\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"SearchSource\\": \\"\\",\\n \\"SearchSourceName\\": \\"\\",\\n \\"PubTime\\": \\"\\",\\n \\"PrimaryOutline\\": \\"\\",\\n \\"Outline\\": \\"\\"\\n }\\n ],\\n \\"Children\\": [\\n {\\n \\"WritingTips\\": \\"\\",\\n \\"OutlineId\\": \\"\\",\\n \\"Outline\\": \\"\\",\\n \\"SearchKeyWordList\\": [\\n \\"\\"\\n ],\\n \\"WordCount\\": \\"\\",\\n \\"Articles\\": [\\n {\\n \\"Url\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"SearchSource\\": \\"\\",\\n \\"SearchSourceName\\": \\"\\",\\n \\"PubTime\\": \\"\\",\\n \\"PrimaryOutline\\": \\"\\",\\n \\"Outline\\": \\"\\"\\n }\\n ],\\n \\"Children\\": [\\n {\\n \\"WritingTips\\": \\"\\",\\n \\"OutlineId\\": \\"\\",\\n \\"Outline\\": \\"\\",\\n \\"SearchKeyWordList\\": [\\n \\"\\"\\n ],\\n \\"WordCount\\": \\"\\",\\n \\"Articles\\": [\\n {\\n \\"Url\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"Content\\": \\"\\",\\n \\"SearchSource\\": \\"\\",\\n \\"SearchSourceName\\": \\"\\",\\n \\"PubTime\\": \\"\\",\\n \\"PrimaryOutline\\": \\"\\",\\n \\"Outline\\": \\"\\"\\n }\\n ],\\n \\"Children\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"文章标题\\",\\n \\"SearchResult\\": {\\n \\"Query\\": \\"\\",\\n \\"Outline\\": \\"\\",\\n \\"OutlineId\\": \\"\\",\\n \\"PrimaryOutline\\": \\"\\",\\n \\"Articles\\": []\\n },\\n \\"GenerateTraceability\\": {\\n \\"News\\": [\\n {\\n \\"Url\\": \\"\\",\\n \\"Title\\": \\"\\",\\n \\"PubTime\\": \\"\\",\\n \\"SearchSourceName\\": \\"\\",\\n \\"SearchSource\\": \\"\\",\\n \\"Index\\": 0\\n }\\n ]\\n }\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 78,\\n \\"OutputTokens\\": 34,\\n \\"TokenMap\\": {\\n \\"key\\": 44\\n },\\n \\"TotalTokens\\": 38\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true\\n}","type":"json"}]',
- 'title' => '智能写作',
- 'requestParamsDescription' => '## 接口请求示例'."\n"
- ."\n"
- .'### 1. 直接写作(使用 Prompt)'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' //业务空间ID'."\n"
- .' "WorkspaceId": "your-workspace-id",'."\n"
- .' //启用检索'."\n"
- .' "UseSearch":true,'."\n"
- .' //写作提示词'."\n"
- .' "Prompt": "请写一篇关于人工智能发展的新闻评论,字数要求800-1000字,要求观点鲜明,逻辑清晰,禁止使用过于夸张的表述。"'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'### 2. 模板写作(PromptMode=Template)'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "WorkspaceId": "your-workspace-id",'."\n"
- .' "WritingScene": "media",'."\n"
- .' "WritingStyle": "新闻评论",'."\n"
- .' "PromptMode": "Template",'."\n"
- .' "WritingParams": {'."\n"
- .' "topic": "人工智能在医疗领域的应用突破,某医院成功使用AI辅助诊断系统,准确率达到95%以上",'."\n"
- .' "corePerspective": "AI医疗技术的快速发展体现了科技创新对传统行业的深刻变革,但同时也需要建立完善的法律法规和伦理规范,确保技术应用的安全性和公平性"'."\n"
- .' }'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'**模板字段说明(传媒场景):**'."\n"
- .'- **topic** (必填): 选题,用简单的语言描述新闻事件或者从常见的新闻中挖掘新颖切入点,1-2000字符'."\n"
- .'- **corePerspective** (必填): 核心观点,明确价值判断立场、体现社会意义或行业影响,1-2000字符'."\n"
- ."\n"
- .'### 3. 高级模式(PromptMode=PE)'."\n"
- .'>(自定义提示词,系统会完全根据提示词进行写作,区分写作主题与写作要求)'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "WorkspaceId": "your-workspace-id",'."\n"
- .' "PromptMode": "PE",'."\n"
- .' "WritingParams": {'."\n"
- .' "topic": "人工智能发展趋势",'."\n"
- .' "prompt": "字数要求:800-1000字。写作风格:观点鲜明,逻辑清晰,语言生动。内容要求:需要包含背景介绍、现状分析、未来展望,重点突出创新点。禁止事项:禁止使用过于夸张的表述,避免使用过于专业的术语。其他要求:需要引用具体数据,要求结构层次分明。"'."\n"
- .' }'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'**模板字段说明(PE模式):**'."\n"
- .'- **topic** (必填): 话题,需要写的主题内容'."\n"
- .'- **prompt** (可选): 其他自定义提示词,其他写作要求。填写时可按以下格式组织内容:'."\n"
- .' - **字数要求**:如"字数800-1000字"、"篇幅控制在1500字左右"'."\n"
- .' - **写作风格**:如"观点鲜明,逻辑清晰"、"语言生动,富有感染力"'."\n"
- .' - **内容要求**:如"需要包含背景介绍、现状分析、未来展望"、"重点突出创新点"'."\n"
- .' - **禁止事项**:如"禁止使用过于夸张的表述"、"避免使用专业术语"'."\n"
- .' - **其他特殊要求**:如"需要引用具体数据"、"要求结构层次分明"'."\n"
- .' '."\n"
- .' 多个要求可以用句号、分号或换行分隔,建议格式:`"字数要求:XXX。写作风格:XXX。内容要求:XXX。禁止事项:XXX。其他要求:XXX。"`'."\n"
- ."\n"
- .'### 4. 分步骤写作 - 第一步:生成大纲'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "WorkspaceId": "your-workspace-id",'."\n"
- .' "WritingStyle": "outlineWriting",'."\n"
- .' "WritingScene": "others",'."\n"
- .' "Step": "OutlineGenerate",'."\n"
- .' "Prompt": "请生成一篇关于人工智能发展的新闻评论大纲,字数要求800-1000字,要求包含背景介绍、现状分析、未来展望三个部分"'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'**说明:**'."\n"
- .'- 第一步生成大纲,返回结果中包含 `Outlines` 字段,包含生成的大纲结构'."\n"
- .'- `Prompt` 中应明确说明要生成的大纲主题、字数要求、结构要求等'."\n"
- .'- 返回的 `Outlines` 结构需要保存,用于第二步传递'."\n"
- ."\n"
- .'### 5. 分步骤写作 - 第二步:使用大纲写作'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "WorkspaceId": "your-workspace-id",'."\n"
- .' "WritingStyle": "outlineWriting",'."\n"
- .' "WritingScene": "others",'."\n"
- .' "Step": "Writing",'."\n"
- .' "OutlineList": ['."\n"
- .' {'."\n"
- .' "OutlineId": "outline-001",'."\n"
- .' "Outline": "人工智能发展背景",'."\n"
- .' "WordCount": "200-300字",'."\n"
- .' "Children": ['."\n"
- .' {'."\n"
- .' "OutlineId": "outline-001-001",'."\n"
- .' "Outline": "人工智能技术起源",'."\n"
- .' "WordCount": "100-150字",'."\n"
- .' "Children": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "OutlineId": "outline-001-002",'."\n"
- .' "Outline": "当前发展现状",'."\n"
- .' "WordCount": "100-150字",'."\n"
- .' "Children": []'."\n"
- .' }'."\n"
- .' ]'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "OutlineId": "outline-002",'."\n"
- .' "Outline": "人工智能应用分析",'."\n"
- .' "WordCount": "300-400字",'."\n"
- .' "Children": []'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "OutlineId": "outline-003",'."\n"
- .' "Outline": "未来发展趋势",'."\n"
- .' "WordCount": "300-400字",'."\n"
- .' "Children": []'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "Prompt": "根据生成的大纲进行写作,字数要求800-1000字,要求观点鲜明,逻辑清晰,语言生动"'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'**说明:**'."\n"
- .'- 第二步使用大纲进行写作,必须传入第一步返回的 `Outlines` 结构'."\n"
- .'- `OutlineList` 是必填参数,包含大纲的层级结构,每个大纲节点包含:'."\n"
- .' - **OutlineId** (必填): 大纲节点ID'."\n"
- .' - **Outline** (必填): 大纲名称'."\n"
- .' - **WordCount** (可选): 该部分的字数要求'."\n"
- .' - **Children** (可选): 子大纲列表,结构同父级大纲'."\n"
- .'- `Prompt` 中可以补充写作要求,如字数、风格、内容要求等'."\n"
- ."\n\n"
- .'### 6. 以稿写稿(快速以稿写稿 - imitateWriting)'."\n"
- ."\n"
- .'```json'."\n"
- .'{'."\n"
- .' "WorkspaceId": "your-workspace-id",'."\n"
- .' "WritingScene": "custom",'."\n"
- .' "WritingStyle": "imitateWriting",'."\n"
- .' "PromptMode": "Template",'."\n"
- .' "WritingParams": {'."\n"
- .' "topic": "新能源汽车市场快速发展,2024年销量突破800万辆,同比增长35%。政策支持、技术进步和消费者接受度提升是主要推动因素。",'."\n"
- .' "styleStructReferenceContent": "[{\\"title\\":\\"人工智能产业迎来爆发式增长\\",\\"content\\":\\"【引言】\\\\n人工智能技术正在深刻改变着我们的生产和生活方式。从智能语音助手到自动驾驶汽车,从医疗诊断到金融风控,AI应用场景不断拓展。\\\\n\\\\n【发展现状】\\\\n据统计,2023年全球人工智能市场规模达到1500亿美元,预计到2025年将突破3000亿美元。中国作为全球第二大AI市场,在算法、算力、数据等方面都取得了显著进展。\\\\n\\\\n【核心驱动因素】\\\\n一是政策支持力度加大。国家出台多项政策支持AI产业发展,设立专项资金,建设创新平台。\\\\n二是技术突破不断涌现。大模型、深度学习等技术日趋成熟,应用门槛逐步降低。\\\\n三是市场需求持续增长。企业数字化转型加速,对AI解决方案的需求日益旺盛。\\\\n\\\\n【挑战与展望】\\\\n尽管发展迅速,但AI产业仍面临数据安全、算法公平性、人才短缺等挑战。未来需要在技术创新、标准制定、人才培养等方面持续发力,推动AI产业健康可持续发展。\\"}]"'."\n"
- .' }'."\n"
- .'}'."\n"
- .'```'."\n"
- ."\n"
- .'**模板字段说明(快速以稿写稿):**'."\n"
- .'- **topic** (必填): 主题内容,描述要写作的主题和核心信息,最大3000字符'."\n"
- .'- **styleStructReferenceContent** (必填): 参考结构的文章列表,需要传入 JSON 数组序列化后的字符串,每个元素包含 `title` 和 `content` 字段,用于学习文章的结构和写作风格'."\n"
- ."\n"
- .'**其他说明:**'."\n"
- ."\n"
- .'- 参考文章应选择结构清晰、层次分明的文章(如:引言-现状-分析-结论的结构)'."\n"
- .'- 系统会学习参考文章的结构框架和写作风格,然后基于新的主题内容生成新文章'."\n"
- .'- 建议只选择一篇结构鲜明的参考文章,以确保生成文章的结构一致性',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false,\\n \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xx\\"\\n }\\n}","type":"json"}]',
],
- 'RunWriting' => [
- 'summary' => '直接写作',
- 'path' => '/quanmiao/aimiaobi/runWriting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'CreateGeneratedContent' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxx_efm'],
],
[
'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '提示词',
- 'description' => '提示词',
- 'type' => 'string',
- 'required' => true,
- 'example' => '提示词',
- ],
+ 'schema' => ['title' => '最后一次生成的提示词', 'description' => '最后一次生成的提示词', 'type' => 'string', 'required' => false, 'example' => '创作xxx文章'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,多轮对话可复用同一轮任务ID',
- 'description' => '任务ID,多轮对话可复用同一轮任务ID'."\n"
- ."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '会话任务唯一标识', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'maxLength' => 64, 'minLength' => 6],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'title' => '单轮对话的ID',
- 'description' => '单轮对话的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => true, 'example' => '杭州亚运会', 'maxLength' => 200, 'minLength' => 2],
],
[
- 'name' => 'OriginSessionId',
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '正文:富文本', 'description' => '正文:富文本', 'type' => 'string', 'required' => true, 'example' => '杭州亚运会'],
+ ],
+ [
+ 'name' => 'ContentDomain',
'in' => 'formData',
'schema' => [
- 'title' => '重新生成时原始对话的ID',
- 'description' => '重新生成时原始对话的ID',
+ 'title' => '内容生成的领域',
+ 'description' => '内容生成的领域',
'type' => 'string',
'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'example' => 'government',
+ 'default' => 'media',
+ 'enum' => ['media', 'government', 'hottopic', 'custom', 'office', 'market'],
],
],
[
- 'name' => 'WritingConfig',
+ 'name' => 'ContentText',
+ 'in' => 'formData',
+ 'schema' => ['title' => '正文:纯文本', 'description' => '正文:纯文本', 'type' => 'string', 'required' => false, 'example' => '杭州亚运会'],
+ ],
+ [
+ 'name' => 'Uuid',
+ 'in' => 'formData',
+ 'schema' => ['title' => '溯源UUID', 'description' => '溯源UUID', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'Keywords',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '写作配置',
- 'description' => '写作配置',
- 'type' => 'object',
- 'properties' => [
- 'Domain' => [
- 'title' => '写作领域,media:传媒,government:政务,market:营销',
- 'description' => '写作领域'."\n"
- ."\n"
- .'- media:传媒'."\n"
- ."\n"
- .'- government:政务'."\n"
- ."\n"
- .'- market:营销',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'media',
- ],
- 'PromptTag' => [
- 'title' => '提示词小助手',
- 'description' => '提示词小助手',
- 'type' => 'object',
- 'properties' => [
- 'NecessaryTips' => [
- 'title' => '必要提示',
- 'description' => '必要提示',
- 'type' => 'string',
- 'required' => false,
- 'example' => '必要提示',
- ],
- 'Position' => [
- 'title' => '立场',
- 'description' => '立场',
- 'type' => 'string',
- 'required' => false,
- 'example' => '立场',
- ],
- 'ReverseWords' => [
- 'title' => '反向词',
- 'description' => '反向词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '反向词',
- ],
- 'Theme' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '主题',
- ],
- ],
- 'required' => false,
- ],
- 'Tags' => [
- 'title' => '写作时的文体、篇幅、输出语言等控制参数',
- 'description' => '写作时的文体、篇幅、输出语言等控制参数',
- 'type' => 'array',
- 'items' => [
- 'description' => '写作时的文体、篇幅、输出语言等控制参数',
- 'type' => 'object',
- 'properties' => [
- 'Keyword' => [
- 'title' => '选项的值',
- 'description' => '选项的值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
- 'Tag' => [
- 'title' => '选项的Tag。例如 gcNumberSizeTag=10',
- 'description' => '选项的Tag。例如 gcNumberSizeTag=10',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gcNumberSizeTag',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'UseSearch' => [
- 'title' => '是否自动补充素材',
- 'description' => '是否自动补充素材',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
+ 'title' => '关键词',
+ 'description' => '关键词',
+ 'type' => 'array',
+ 'items' => ['description' => '关键字', 'type' => 'string', 'required' => false, 'example' => '关键词'],
'required' => false,
],
],
- [
- 'name' => 'ReferenceData',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '写作时的参考文章数据',
- 'description' => '写作时的参考文章数据',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Articles' => [
- 'title' => '写作时的参考文章数据',
- 'description' => '写作时的参考文章数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '写作时的参考文章数据',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'required' => false,
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2124ca4d48a542d788aa86151e1a8c8b',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-08-28 11:38:28',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int64', 'example' => '42'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
],
- 'required' => false,
],
],
],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '保存文档',
+ 'summary' => '保存文档:用来保存妙笔中创作的文章,支持富文本。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-13T08:39:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-09T07:40:12.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGeneratedContent'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": 42,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ ],
+ 'CreateToken' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm'],
+ ],
+ ],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'BaseLlmResponse',
- 'description' => 'BaseLlmResponse',
+ 'title' => 'PlainResult<AccessTokenInfo>',
+ 'description' => 'PlainResult<AccessTokenInfo>',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'StatusCode' => [
- 'title' => 'http响应码',
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '参照文章',
- 'description' => '参照文章',
- 'type' => 'array',
- 'items' => [
- 'description' => '参照文章',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => '98229f6001cf4deeb1668191d4eccc75',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-08-28 11:38:28',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- ],
- ],
- ],
- 'MiniDoc' => [
- 'title' => '文章精排之后的片段列表',
- 'description' => '文章精排之后的片段列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '文章精排之后的片段'."\n"
- .' * ',
- 'description' => '文章精排之后的片段'."\n"
- .' * ',
- 'type' => 'string',
- 'example' => '文章精排之后的片段',
- ],
- 'example' => '文章精排之后的片段',
- ],
- 'SearchQuery' => [
- 'title' => 'query改写结果',
- 'description' => 'query改写结果',
- 'type' => 'string',
- 'example' => '大模型改变世界',
- ],
- 'Text' => [
- 'title' => '文本生成结果',
- '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',
- ],
- 'TokenMap' => [
- 'description' => 'token消耗明细',
- 'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '44',
- 'description' => 'token消耗明细',
- ],
- ],
- 'TotalTokens' => [
- 'description' => '本次调用使用的所有Token数总和',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- ],
- ],
+ 'ExpiredTime' => ['title' => '有效期', 'description' => '有效期', 'type' => 'integer', 'format' => 'int64', 'example' => '1705388704855'],
+ 'Token' => ['title' => '访问授权码', 'description' => '访问授权码', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'End' => [
- 'description' => '此次请求是否结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取授权token',
+ 'summary' => '创建在线推理API的临时Token。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateToken'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"98229f6001cf4deeb1668191d4eccc75\\",\\n \\"PubTime\\": \\"2024-08-28 11:38:28\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"MiniDoc\\": [\\n \\"文章精排之后的片段\\"\\n ],\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TokenMap\\": {\\n \\"key\\": 44\\n },\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true\\n}","type":"json"}]',
- 'title' => '直接写作',
- 'description' => '该接口已过时,请参考: [RunWritingV2](~~2922606~~)',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"ExpiredTime\\": 1705388704855,\\n \\"Token\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunStepByStepWriting' => [
- 'summary' => '使用大纲+摘编的分步骤的模式进行写作。',
- 'path' => '/quanmiao/miaobi/runStepByStepWriting',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteAuditNote' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5382,660 +2795,206 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'NoteId',
'in' => 'formData',
+ 'schema' => ['title' => '规则库Id ,不填默认Default', 'description' => '规则库Id ,不填默认Default', 'type' => 'string', 'required' => false],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '提示词',
- 'description' => '提示词',
- 'type' => 'string',
- 'required' => true,
- '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '删除结果。如果删除成功,会返回“SUCCESSED”。', 'description' => '删除结果。如果删除成功,会返回“SUCCESSED”。', 'type' => 'string', 'example' => 'SUCCESSED'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除规则库',
+ 'summary' => '删除用户账户下所有可供审核使用的自定义规则库。删除后无法找回,如果您有对规则库存档的需求,请预先使用 DownloadAuditNote 接口保存需要的规则库。',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,多轮对话可复用同一轮任务ID',
- 'description' => '任务ID,多轮对话可复用同一轮任务ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"SUCCESSED\\"\\n}","type":"json"}]',
+ ],
+ 'DeleteAuditTerms' => [
+ 'summary' => '删除指定的词库记录。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'SessionId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '单轮对话的ID',
- 'description' => '单轮对话的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'OriginSessionId',
+ 'name' => 'IdList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '重新生成时原始对话的ID',
- 'description' => '重新生成时原始对话的ID',
- 'type' => 'string',
+ 'title' => '指定要删除的用户登录的规则id列表。',
+ 'description' => '指定要删除的用户登录的规则id列表。',
+ 'type' => 'array',
+ 'items' => ['title' => '指定要删除的用户登录的规则id列表。', 'description' => '指定要删除的用户登录的规则id列表。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4463'],
'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
],
],
- [
- 'name' => 'WritingConfig',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '写作配置',
- 'description' => '写作配置',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Domain' => [
- 'title' => '写作领域:media(默认):传媒写作,government:公文写作',
- 'description' => '写作领域'."\n"
- ."\n"
- .'- media(默认):传媒写作'."\n"
- ."\n"
- .'- government:公文写作',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'media',
- 'enum' => [
- 'media',
- 'government',
- ],
- ],
- 'Keywords' => [
- 'title' => '关键词(影响文章检索)',
- 'description' => '关键词(影响文章检索)',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键词(string)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关键词',
- ],
- 'required' => false,
- ],
- 'PromptTag' => [
- 'title' => '提示词小助手',
- 'description' => '提示词小助手',
- 'type' => 'object',
- 'properties' => [
- 'NecessaryTips' => [
- 'title' => '必要提示',
- 'description' => '必要提示',
- 'type' => 'string',
- 'required' => false,
- 'example' => '必要提示',
- ],
- 'Position' => [
- 'title' => '立场',
- 'description' => '立场',
- 'type' => 'string',
- 'required' => false,
- 'example' => '立场',
- ],
- 'ReverseWords' => [
- 'title' => '反向词',
- 'description' => '反向词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '反向词',
- ],
- 'Theme' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '主题',
- ],
- ],
- 'required' => false,
- ],
- 'Scene' => [
- 'title' => '分步骤写作场景,传媒写作支持的写作场景:新闻写作(默认),新闻评论,通用文体,公文写作支持的写作场景:通知(默认),通告,通报,请示,决定,函,通用文体',
- 'description' => '分步骤写作场景'."\n"
- ."\n"
- .'- 传媒写作支持的写作场景:新闻写作(默认)、新闻评论、通用文体'."\n"
- ."\n"
- .'- 公文写作支持的写作场景:通知(默认)、通告、通报、请示、决定、函、通用文体',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新闻写作',
- ],
- 'Step' => [
- 'title' => '写作步骤-生成大纲:OutlineGenerate、生成摘编:MiniDocSummary,Writing(默认):生成文章',
- 'description' => '写作步骤'."\n"
- ."\n"
- .'- 生成大纲:OutlineGenerate'."\n"
- ."\n"
- .'- 生成摘编:MiniDocSummary'."\n"
- ."\n"
- .'- Writing(默认):生成文章',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Writing',
- 'enum' => [
- 'OutlineGenerate',
- 'MiniDocSummary',
- 'Writing',
- ],
- ],
- 'Tags' => [
- 'title' => '写作时的文体、篇幅、输出语言等控制参数',
- 'description' => '写作时的文体、篇幅、输出语言等控制参数',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签对象',
- 'type' => 'object',
- 'properties' => [
- 'Keyword' => [
- 'title' => '选项的值',
- 'description' => '选项的值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
- 'Tag' => [
- 'title' => '选项的Tag。例如 gcNumberSizeTag=10',
- 'description' => '选项的Tag。例如 gcNumberSizeTag=10',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'gcNumberSizeTag',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'UseSearch' => [
- 'title' => '是否自动补充素材',
- 'description' => '是否自动补充素材',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'SummaryReturnType' => [
- 'title' => '摘编结果的返回类型(枚举值:Structure、Content、Event)'."\n"
- .'Structure:表示在 payload.output.text中返回json字符串:{"event":"{outline}","message":"{message}"}'."\n"
- ."\n"
- .'Content: 表示在 payload.output.text中返回纯文本的摘编内容:大纲:{outline}\\n\\n{message}\\n\\n\\n大纲:{outline}\\n\\n{message}'."\n"
- ."\n"
- .'Event: 表示 仅在每次大纲写完时,在 payload.output.text中 返回大纲 {outline} 信息。如果有六个大纲需要写,则会返回六条大纲信息',
- 'description' => '摘编结果的返回类型:<br/>'."\n"
- .'- Structure:'."\n"
- .' 表示在 payload.output.text中返回json字符串。示例格式:```{"event":"{outline}","message":"{message}"}```'."\n"
- .'- Content: 仅在 payload.output.text中返回纯文本的摘编内容。示例格式:'."\n"
- .' ```大纲:{outline}\\n\\n{message}\\n\\n\\n大纲:{outline}\\n\\n{message}```'."\n"
- ."\n"
- .'- Event: 仅在每次大纲写完时,在 payload.output.text中 返回大纲内容本身。一般会返回六条大纲',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Structure',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => false,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除指定词库记录',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ReferenceData',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '写作时的参考文章数据',
- 'description' => '写作时的参考文章数据',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '写作时的参考文章数据',
- 'description' => '写作时的参考文章数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '写作时的参考文章数据',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'required' => false,
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => '8a20e007a6174522af4d6a2657d5526f',
- ],
- 'MediaUrl' => [
- 'description' => '原始素材地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-09-10 14:17:54',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'MiniDoc' => [
- 'title' => '排序Rank后的文章片段(用于后续模型生成)',
- 'description' => '排序Rank后的文章片段(用于后续模型生成)',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章片段',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章片段',
- ],
- 'required' => false,
- ],
- 'Outlines' => [
- 'title' => '大纲(可以指定数据源生成大纲)',
- 'description' => '大纲(可以指定数据源生成大纲)',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '指定大纲数据源',
- 'description' => '指定大纲数据源',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '文章内容',
- 'description' => '文章内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章内容',
- ],
- 'Title' => [
- 'title' => '文章标题',
- 'description' => '文章标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章链接',
- 'description' => '文章链接',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章链接',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'required' => false,
- 'example' => '大纲',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'Summarization' => [
- 'title' => '大模型摘编总结结果',
- 'description' => '大模型摘编总结结果',
- 'type' => 'array',
- 'items' => [
- 'description' => '摘编结果(模型上下文)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '摘编结果(模型上下文)',
- ],
- 'required' => false,
- ],
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteCustomText' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '85'],
+ ],
+ [
+ 'name' => 'CommodityCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '商品Code', 'description' => '商品code', 'type' => 'string', 'required' => false, 'example' => '商品code'],
+ ],
+ ],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'BaseLlmResponse',
- 'description' => 'BaseLlmResponse',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '参照文章',
- 'description' => '参照文章',
- 'type' => 'array',
- 'items' => [
- 'description' => '参照文章',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'f1da53894e784759946d22e2cb2b522a',
- ],
- 'MediaUrl' => [
- 'description' => '原始素材地址',
- 'type' => 'string',
- 'example' => 'http://www.example.com',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-09-10 14:17:53',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- ],
- ],
- ],
- 'ExtraOutput' => [
- 'title' => '额外输出字段',
- 'description' => '额外输出字段',
- 'type' => 'object',
- 'properties' => [
- 'summarization' => [
- 'title' => '摘编列表(分步骤生成摘编时,会返回该字段)',
- 'description' => '摘编列表(分步骤生成摘编时,会返回该字段)',
- 'type' => 'array',
- 'items' => [
- 'title' => '摘编字段',
- 'description' => '摘编字段',
- 'type' => 'string',
- 'example' => '摘编',
- ],
- ],
- ],
- ],
- 'MiniDoc' => [
- 'title' => '文章精排之后的片段列表',
- 'description' => '文章精排之后的片段列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '文章精排之后的片段'."\n"
- .' * ',
- 'description' => '文章精排之后的片段'."\n"
- .' * ',
- 'type' => 'string',
- 'example' => '文章精排之后的片段',
- ],
- 'example' => '文章精排之后的片段',
- ],
- 'SearchQuery' => [
- 'title' => 'query改写结果',
- 'description' => 'query改写结果',
- 'type' => 'string',
- 'example' => '大模型改变世界',
- ],
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- ],
- ],
- 'Usage' => [
- 'title' => 'Token用量信息',
- 'description' => 'Token用量信息',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'title' => '输入Token数',
- 'description' => '输入Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65',
- ],
- 'OutputTokens' => [
- 'title' => '输出Token数',
- 'description' => '输出Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '80',
- ],
- 'TotalTokens' => [
- 'title' => '总Token数',
- 'description' => '总Token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '唯一请求ID',
- 'description' => '唯一请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '业务数据', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除自定义文本',
+ 'summary' => '删除自定义文本。',
+ 'changeSet' => [
+ ['createdAt' => '2024-08-13T00:21:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-08-13T00:21:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"f1da53894e784759946d22e2cb2b522a\\",\\n \\"MediaUrl\\": \\"http://www.example.com\\",\\n \\"PubTime\\": \\"2024-09-10 14:17:53\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"ExtraOutput\\": {\\n \\"summarization\\": [\\n \\"摘编\\"\\n ]\\n },\\n \\"MiniDoc\\": [\\n \\"文章精排之后的片段\\"\\n ],\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 65,\\n \\"OutputTokens\\": 80,\\n \\"TotalTokens\\": 32\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
- 'title' => '分步骤写作',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunTranslateGeneration' => [
- 'summary' => 'AI妙笔-创作-中英文翻译。',
- 'path' => '/quanmiao/aimiaobi/runTranslateGeneration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteCustomTopicByTopic' => [
+ 'summary' => '根据热点名称删除自定义热点事件。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6043,400 +3002,256 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'ReferenceData',
+ 'name' => 'Topic',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '自定义主题', 'description' => '自定义主题', 'type' => 'string', 'required' => true, 'example' => '话题'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功',
'schema' => [
- 'description' => '生成需要的数据',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Contents' => [
- 'description' => '正文列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '正文',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
- 'required' => true,
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int32', 'example' => '33'],
+ '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'],
],
- 'required' => true,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除自定义热点事件',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '非必填,关联创作文章唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteCustomTopicByTopic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": 33,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteCustomTopicViewPointById' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Prompt',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'CustomViewPointId',
'in' => 'formData',
- 'schema' => [
- 'description' => '支持的翻译的语种(源语言系统会自动识别)'."\n"
- .'| language | prompt |'."\n"
- .'|----------|--------|'."\n"
- .'| 英语 | English |'."\n"
- .'| 简体中文 | Chinese |'."\n"
- .'| 日语 | Japanese |'."\n"
- .'| 韩语 | Korean |'."\n"
- .'| 西班牙语 | Spanish |'."\n"
- .'| 法语 | French |'."\n"
- .'| 葡萄牙语 | Portuguese |'."\n"
- .'| 德语 | German |'."\n"
- .'| 意大利语 | Italian |',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'English',
- ],
+ 'schema' => ['title' => '自定义视角ID', 'description' => '自定义视角ID', 'type' => 'string', 'required' => true, 'example' => 'dfd73894e6a94fd79fe7ffbe865796fb'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'AccessForbid',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Event' => [
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '91C2B2B8-7D12-4A8D-A724-1E576D30C096',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0abb781d17146157564845243e20b5',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- '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',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int32', 'example' => '7'],
+ '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'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除自定义选题视角',
+ 'summary' => '根据自定义选题视角ID删除自定义选题视角。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteCustomTopicViewPointById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"91C2B2B8-7D12-4A8D-A724-1E576D30C096\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0abb781d17146157564845243e20b5\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\"\\n}","type":"json"}]',
- 'title' => '中英翻译',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": 7,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunTextPolishing' => [
- 'summary' => '创作-文本润色。',
- 'path' => '/quanmiao/aimiaobi/runTextPolishing',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteDataPermissions' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'Content',
+ 'name' => 'Ids',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '待润色的文章段落',
- 'description' => '文本内容',
- 'type' => 'string',
+ 'title' => '权限id',
+ 'description' => '权限id',
+ 'type' => 'array',
+ 'items' => ['title' => '权限id', 'description' => '权限id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'required' => true,
- 'example' => '文本内容',
],
],
- [
- 'name' => 'Prompt',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '自定义提示词',
- 'description' => '自定义的润色要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义的润色要求',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '权限-删除',
+ 'summary' => '权限-批量删除:'."\n"
+ .'- 数据集权限',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'OriginContent',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '原始文章',
- 'description' => '原始文章',
- 'type' => 'string',
- 'required' => false,
- 'example' => '原始文章内容',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDataPermissions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'DeleteDataset' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TaskId',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,(同一个任务ID共享会话)',
- 'description' => '任务ID,(同一个任务ID共享会话,任务超时时间12个小时)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'taskld-xxxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'DatasetId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'BaseLlmResponse',
- 'description' => 'BaseLlmResponse',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '文本生成结果',
- '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',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-删除',
+ 'summary' => '数据源管理-删除。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
- 'title' => '润色',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'RunKeywordsExtractionGeneration' => [
- 'summary' => 'AI妙笔-创作-抽取关键词。',
- 'path' => '/quanmiao/aimiaobi/runKeywordsExtractionGeneration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteDatasetDocument' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6444,65 +3259,104 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'ReferenceData',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识:和DatasetName二选一必选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DatasetName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => '数据集名称'],
+ ],
+ [
+ 'name' => 'DocId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '用户指定的文档唯一ID', 'description' => '用户指定的文档唯一ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'DocUuid',
+ 'in' => 'formData',
+ 'schema' => ['description' => '内部文档唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '生成需要的数据',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Contents' => [
- 'description' => '正文列表',
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'array',
- 'items' => [
- 'description' => '正文',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
- 'required' => true,
+ 'items' => ['description' => '删除文档唯一标识', 'type' => 'string', 'example' => 'xxx'],
],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
- 'required' => true,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-删除数据集文档',
+ 'summary' => '删除数据源文档。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '关联创作文章唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n \\"xxx\\"\\n ],\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'DeleteDocs' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Prompt',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
+ ],
+ [
+ 'name' => 'DocIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '自定义提示词',
- 'description' => '自定义提示词',
- 'type' => 'string',
- 'required' => false,
+ 'description' => '文档ID数组',
+ 'type' => 'array',
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ 'required' => true,
],
],
],
@@ -6513,151 +3367,67 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'AccessForbid',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Event' => [
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '1a3d7c9f-3a6d-4e49-b176-2d8721a27397',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '8d55b429d7c6d321fcff54823e8d317b',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '210bc4e817219607963985396de8bd',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '419F3FBE-5C8D-5949-AC29-E9615235D15A',
- ],
+ 'Code' => ['description' => '内部错误码。', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '返回信息', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '2C565EDD-E624-5FED-8565-0A9CB0C8CC46'],
+ 'Success' => ['description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"1a3d7c9f-3a6d-4e49-b176-2d8721a27397\\",\\n \\"TaskId\\": \\"8d55b429d7c6d321fcff54823e8d317b\\",\\n \\"TraceId\\": \\"210bc4e817219607963985396de8bd\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xxx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"419F3FBE-5C8D-5949-AC29-E9615235D15A\\"\\n}","type":"json"}]',
- 'title' => '关键词抽取',
- ],
- 'RunContinueContent' => [
- 'summary' => '内容续写。',
- 'path' => '/quanmiao/aimiaobi/runContinueContent',
- 'methods' => [
- 'post',
+ 'title' => '批量删除文档',
+ 'summary' => '妙读删除多个文档。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDocs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2C565EDD-E624-5FED-8565-0A9CB0C8CC46\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteFactAuditUrl' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间id',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Content',
+ 'name' => 'Url',
'in' => 'formData',
- 'schema' => [
- 'title' => '需要续写的内容',
- 'description' => '需要续写的内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。',
- ],
+ 'schema' => ['title' => '用户希望删除的审核信息来源 URL,填写的 URL 需要和通过GetFactAuditUrl 得到的结果一致才能顺利删除。', 'description' => '用户希望删除的审核信息来源 URL,填写的 URL 需要和通过GetFactAuditUrl 得到的结果一致才能顺利删除。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com'],
],
],
'responses' => [
@@ -6667,142 +3437,42 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- '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' => '模型生成事件',
- ],
- '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',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
- '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' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求唯一ID',
- 'description' => '请求唯一ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '删除 URL 的成功提示。', 'description' => '删除 URL 的成功提示。', 'type' => 'string', 'example' => 'SUCCESSED'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除事实性审核 URL',
+ 'summary' => '删除指定的用于事实性审核的 URL。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteFactAuditUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
- 'title' => '内容续写',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"SUCCESSED\\"\\n}","type":"json"}]',
],
- 'RunWriteToneGeneration' => [
- 'summary' => 'AI妙笔-创作-文风改写。',
- 'path' => '/quanmiao/aimiaobi/runWriteToneGeneration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteGeneralConfig' => [
+ 'summary' => '通用配置-删除',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6810,185 +3480,216 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-'],
],
[
- 'name' => 'ReferenceData',
+ 'name' => 'ConfigKey',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '配置唯一标识', 'description' => '配置唯一标识', 'type' => 'string', 'required' => true, 'example' => 'xx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功',
'schema' => [
- 'description' => '生成需要的数据',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Contents' => [
- 'description' => '正文列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '正文',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
- 'required' => true,
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
- 'required' => true,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通用配置-删除',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '关联创作文章唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'DeleteGeneratedContent' => [
+ 'summary' => '删除文档:用来删除妙笔中创作的文章。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Prompt',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Id',
'in' => 'formData',
+ 'schema' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '99'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '文风:比如"抒情", "豪放", "含蓄", "激动", "亲切", "励志"',
- 'type' => 'string',
- 'required' => true,
- 'example' => '励志',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'true'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除文档',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGeneratedContent'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DeleteInterveneRule' => [
+ 'summary' => '删除干预规则。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'RuleId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '规则id', 'description' => '规则id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
+ ],
+ ],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<OperationResult>',
+ 'description' => 'PlainResult<OperationResult>',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'AccessForbid',
- ],
- 'ErrorMessage' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Event' => [
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
+ 'FailIdList' => [
+ 'title' => '失败的索引id列表',
+ 'description' => '失败的索引id列表',
+ 'type' => 'array',
+ 'items' => ['description' => '失败的id列表', 'type' => 'string', 'example' => '12345'],
],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => 'dt-s50ntwtywb4y'],
+ 'Code' => ['description' => '干预服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'FB698445-61DA-5361-BF73-1C5F1157E888',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除干预规则',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteInterveneRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"F1953EE6-157C-40DC-BBF1-87C98AC27C51\\",\\n \\"TaskId\\": \\"F1953EE6-157C-40DC-BBF1-87C98AC27C51\\",\\n \\"TraceId\\": \\"F1953EE6-157C-40DC-BBF1-87C98AC27C51\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xxx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"FB698445-61DA-5361-BF73-1C5F1157E888\\"\\n}","type":"json"}]',
- 'title' => '文风改写',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"12345\\"\\n ],\\n \\"TaskId\\": \\"dt-s50ntwtywb4y\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunTitleGeneration' => [
- 'summary' => '妙笔:标题生成。',
- 'path' => '/quanmiao/aimiaobi/runTitleGeneration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteMaterialById' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -6996,84 +3697,92 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'],
],
[
- 'name' => 'ReferenceData',
+ 'name' => 'Id',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '要生成标题的数据',
+ 'title' => '返回是否删除成功',
+ 'description' => '返回是否删除成功',
'type' => 'object',
'properties' => [
- 'Contents' => [
- 'description' => '正文列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '正文',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
- 'required' => true,
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'false'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
],
- 'required' => true,
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除素材',
+ 'summary' => '删除素材:删除素材库中素材。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteMaterialById'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '关联创作文章唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteMaterialById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ ],
+ 'DeletePptArtifact' => [
+ 'summary' => '删除PPT作品',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TitleCount',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '标题生成个数,最大10个。',
- 'description' => '标题生成个数,最大10个。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'DeduplicatedTitles',
+ 'name' => 'PptArtifactId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '新生成的标题 需要与之去重的标题集合。所有标题字数最多5K个字',
- 'description' => '新生成的标题 需要与之去重的标题集合。所有标题字数最多5K个字',
- 'type' => 'array',
- 'items' => [
- 'description' => '待去重的标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标题xxxx',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => 'PPT作品ID', 'description' => 'PPT作品ID', 'type' => 'string', 'required' => false, 'example' => '53245'],
+ ],
+ [
+ 'name' => 'ExternalUserId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '第三方传入的用户ID', 'type' => 'string', 'example' => 'abc'],
],
],
'responses' => [
@@ -7083,379 +3792,236 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'AccessForbid',
- ],
- 'ErrorMessage' => [
- 'description' => '错误码消息。',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Event' => [
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'StatusCode' => [
- 'description' => '状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '50a1cc8e-717e-4a2b-a76b-dc9734a8564b',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0a3d448f17000139741898287e0eb3',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '任务响应对象',
+ 'description' => '响应对象',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
- ],
+ 'PptArtifactId' => ['title' => '任务ID', 'description' => 'PPT作品ID', 'type' => 'integer', 'format' => 'int32', 'example' => '5233498'],
],
],
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'AccessForbid',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除PPT作品',
+ 'description' => '接入说明:'."\n"
+ ."\n"
+ .'- 当前接口为 HTTP-SSE 协议。'."\n"
+ .'- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持Java、Python版本的 sdk)请参考[PPT生成最佳实践文档](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices)。'."\n"
+ .'- 其中获取 Java 异步 SDK 的最新版本: [请点击链接获取](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?spm=a2c4g.11186623.0.0.4cd3170d7rccDC&version=2023-08-01&language=java-async-tea&tab=primer-doc)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeletePptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"50a1cc8e-717e-4a2b-a76b-dc9734a8564b\\",\\n \\"TraceId\\": \\"0a3d448f17000139741898287e0eb3\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xxx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"AccessForbid\\",\\n \\"Message\\": \\"数据不存在\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '标题生成',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"PptArtifactId\\": 5233498\\n }\\n}","type":"json"}]',
],
- 'RunSummaryGenerate' => [
- 'summary' => '内容摘要生成。',
- 'path' => '/quanmiao/aimiaobi/runSummaryGenerate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DeleteStyleLearningResult' => [
+ 'summary' => '删除指定自定义文体。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Id',
'in' => 'formData',
+ 'schema' => ['title' => '文体学习ID', 'description' => '文体学习ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => '业务空间id',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'xxx'],
+ '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'],
+ ],
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '删除自定义文体',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '需要生成摘要的内容',
- 'description' => '需要生成摘要的内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'DocumentExtraction' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Prompt',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Urls',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '自定义摘要Prompt.',
- 'description' => '自定义摘要Prompt.',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请为上述内容生成一段摘要,字数在100~200字以内。',
- 'default' => '请为上述内容生成一段摘要,字数在100~200字以内。',
+ 'title' => '待提取的链接列表',
+ 'description' => '待提取的链接列表',
+ 'type' => 'array',
+ 'items' => ['title' => 'URL链接', 'description' => 'URL链接,URL长度不能超过2048', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/'],
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- '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' => '模型生成事件',
- ],
- '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',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
- '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' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文档对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => '8df2d69d63a247b6b52ff455b2d426b6'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-05-14 08:54:33'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '新闻来源'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
],
],
],
- 'RequestId' => [
- 'title' => '请求唯一ID',
- 'description' => '请求唯一ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '文档提取',
+ 'summary' => '从链接中提取文档内容。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DocumentExtraction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
- 'title' => '摘要生成',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"8df2d69d63a247b6b52ff455b2d426b6\\",\\n \\"PubTime\\": \\"2024-05-14 08:54:33\\",\\n \\"Source\\": \\"新闻来源\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunExpandContent' => [
- 'summary' => '内容扩写。',
- 'path' => '/quanmiao/aimiaobi/runExpandContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DownloadAuditNote' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间id',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Content',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '需要扩写的内容',
- 'description' => '需要扩写的内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。',
- ],
+ 'schema' => ['title' => '用户通过 SubmitAuditNote 接口得到的 taskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。'."\n"
+ .'在您使用本接口时,如果在入参中包含 taskId,能获取到您已通过 SubmitAuditNote 接口上传成功,但未通过 ConfirmAndProcessAuditNote 进行后处理的结构化规则库;而入参中不包含 taskId 时,则能获取到已进行后处理,可以用于审核的结构化规则库。', 'description' => '用户通过 SubmitAuditNote 接口得到的 taskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。'."\n"
+ .'在您使用本接口时,如果在入参中包含 taskId,能获取到您已通过 SubmitAuditNote 接口上传成功,但未通过 ConfirmAndProcessAuditNote 进行后处理的结构化规则库;而入参中不包含 taskId 时,则能获取到已进行后处理,可以用于审核的结构化规则库。', 'type' => 'string', 'required' => false, 'example' => 'xxx_Default_1241541251241'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'NoteId',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义提示词',
- 'description' => '自定义提示词',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '规则库Id ,不填默认Default', 'description' => '规则库Id ,不填默认Default', 'type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -7465,187 +4031,62 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- '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' => '模型生成事件',
- ],
- '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',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
- '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' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求唯一ID',
- 'description' => '请求唯一ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '目标规则库下载链接。', 'description' => '目标规则库下载链接。', 'type' => 'string', 'example' => 'http://download.xxx.yyy.zzz'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '下载规则库',
+ 'summary' => '您可以通过调用该接口下载结构化后的规则库,供您进行进一步处理。该接口同时拥有两个功能:下载未后处理的结构化规则库,或下载当前可用于审核的结构化规则库。具体使用方法,请参考入参说明。',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DownloadAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
- 'title' => '内容扩写',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"http://download.xxx.yyy.zzz\\"\\n}","type":"json"}]',
],
- 'RunAbbreviationContent' => [
- 'summary' => '内容缩写。',
- 'path' => '/quanmiao/aimiaobi/runAbbreviationContent',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'DownloadBiddingDoc' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间id',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq'],
],
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '需要缩写的内容',
- 'description' => '需要缩写的内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。',
- ],
- ],
- [
- 'name' => 'Prompt',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义提示词',
- 'description' => '自定义提示词',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'],
],
],
'responses' => [
@@ -7655,409 +4096,146 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- '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' => '模型生成事件',
- ],
- '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',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'HttpStatusCode' => ['description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ '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' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
+ 'TaskId' => ['description' => '任务id', 'type' => 'string', 'example' => '111_Default_20250708142918'],
+ 'Url' => ['description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
],
],
- 'RequestId' => [
- 'title' => '请求唯一ID',
- 'description' => '请求唯一ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
- 'title' => '内容缩写',
- ],
- 'SearchNews' => [
- 'summary' => '根据输入检索新闻,目前仅支持互联网搜索。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '下载标书文件',
+ 'summary' => '标书下载接口',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DownloadBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"111_Default_20250708142918\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
+ ],
+ 'EditAuditTerms' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'SearchSources',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '检索源列表',
- 'description' => '检索源列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '搜索源code。非必填、目前仅支持:QuarkCommonNews。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
- ],
- 'required' => false,
- 'enumValueTitles' => [],
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Query',
+ 'name' => 'Keyword',
'in' => 'formData',
- 'schema' => [
- 'title' => '检索Query',
- 'description' => '检索Query',
- 'type' => 'string',
- 'required' => false,
- 'example' => '检索Query',
- ],
+ 'schema' => ['title' => '关键词', 'description' => '关键词', 'type' => 'string', 'required' => false, 'example' => '龘'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'SuggestWord',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页记录数',
- 'description' => '每页记录数,默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '建议词', 'description' => '建议词', 'type' => 'string', 'required' => false, 'example' => '龘(dá)'],
],
[
- 'name' => 'Page',
+ 'name' => 'TermsDesc',
'in' => 'formData',
- 'schema' => [
- 'title' => '页码',
- 'description' => '当前页号。默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '审核依据', 'description' => '审核依据', 'type' => 'string', 'required' => false, 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。'],
],
[
- 'name' => 'IncludeContent',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否包含正文',
- 'description' => '是否包含正文',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'string', 'required' => false, 'example' => '20103'],
],
[
- 'name' => 'FilterNotNull',
+ 'name' => 'ExceptionWord',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '是否过滤空内容',
- 'description' => '是否过滤空内容',
- 'type' => 'boolean',
+ 'title' => '例外语句',
+ 'description' => '例外语句',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
- 'example' => 'false',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageResult',
- 'description' => 'PageResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Current' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回结果。',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => '9a598b44c6444da5907b8ea68a5f82c4',
- ],
- 'ImageUrls' => [
- 'title' => '图片地址',
- 'description' => '图片地址',
- 'type' => 'array',
- 'items' => [
- 'description' => '新闻图像的URL。',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaaa.jpg',
- ],
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-01-18 06:46:22',
- ],
- 'SearchSource' => [
- 'title' => '搜索源',
- 'description' => '搜索源',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索源名称',
- 'description' => '搜索源名称',
- 'type' => 'string',
- 'example' => '夸克检索',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'UpdateTime' => [
- 'title' => '系统更新时间',
- 'description' => '系统更新时间',
- 'type' => 'string',
- 'example' => '2024-01-18 06:46:22',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => '文章URL',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Size' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '编辑自定义词库记录',
+ 'summary' => '编辑审核自定义词库记录',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-15T05:32:39.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocUuid\\": \\"9a598b44c6444da5907b8ea68a5f82c4\\",\\n \\"ImageUrls\\": [\\n \\"https://www.example.com/aaaa.jpg\\"\\n ],\\n \\"PubTime\\": \\"2024-01-18 06:46:22\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"夸克检索\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"UpdateTime\\": \\"2024-01-18 06:46:22\\",\\n \\"Url\\": \\"文章URL\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
- 'title' => '信息检索',
- ],
- 'RunQuickWriting' => [
- 'summary' => '可直接输入写作指令,进行快速写作。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:EditAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true\\n}","type":"json"}]',
+ ],
+ 'EditBiddingDoc' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8065,263 +4243,90 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID,多轮对话可复用同一轮任务ID',
- 'description' => '任务ID,多轮对话可复用同一轮任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba'],
],
[
- 'name' => 'Articles',
+ 'name' => 'Content',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '引用的文章',
- 'description' => '引用的文章',
- 'type' => 'array',
- 'items' => [
- 'title' => '文章对象',
- 'description' => '文章对象',
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'title' => '文章标题',
- 'description' => '文章标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- ],
- 'Content' => [
- 'title' => '文章内容',
- 'description' => '文章内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章内容',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- ],
- 'required' => false,
- 'example' => '文章对象'."\n",
- ],
- 'required' => false,
- 'example' => '集合',
- ],
+ 'schema' => ['description' => '文本内容', 'type' => 'string', 'required' => false, 'example' => '标书内容'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'ContentType',
'in' => 'formData',
- 'schema' => [
- 'title' => '其他写作参数(prompt 和 writingParams 二选一)',
- 'description' => '其他写作参数(prompt 和 writingParams 二选一)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '请按英文输出',
- ],
+ 'schema' => ['description' => '内容类型', 'type' => 'string', 'required' => false, 'example' => 'outline'."\n"
+ .'bidding'],
],
[
- 'name' => 'SearchSources',
+ 'name' => 'ContentFormat',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '使用指定的搜索源列表',
- 'description' => '使用指定的搜索源列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '搜索源对象',
- 'description' => '搜索源对象',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索',
- 'description' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SystemSearch',
- ],
- 'DatasetName' => [
- 'title' => '数据源唯一标识',
- 'description' => '数据源唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '格式', 'type' => 'string', 'required' => false, 'example' => 'html'."\n"
+ .'markdown'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'BaseLlmResponse',
- 'description' => 'BaseLlmResponse',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'successful'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'StatusCode' => [
- 'title' => 'http响应码',
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'Token用量信息',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '78',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '34',
- ],
- 'TotalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '38',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'End' => [
- 'description' => '响应包是否结束',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 78,\\n \\"OutputTokens\\": 34,\\n \\"TotalTokens\\": 38\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": false\\n}","type":"json"}]',
- 'title' => '快速写作',
- 'description' => '### 接入说明:'."\n"
- .'- 由于OpenAPI门户目前对SSE推理协议不兼容(无法直接调试),接口SDK方式调用示例请参考[妙笔最佳实践](https://help.aliyun.com/zh/model-studio/best-practices-for-miaobi-api?spm=a2c4g.11186623.help-menu-2400256.d_1_12_6_2_1_0.39892421FntuI2&scm=20140722.H_2844289._.OR_help-T_cn~zh-V_1)文档。'."\n"
- .'- 获取Java异步SDK的最新版本:请点击[链接](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?version=2023-08-01&language=java-async-tea&tab=primer-doc)获取。'."\n",
- ],
- 'ListBuildConfigs' => [
- 'summary' => '获取系统自定义预设,用于创作文章 -> 直接生成中的内置选项。例如:写作文体、文章篇幅、输出语言、生成文章篇数等选项。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '编辑标书内容',
+ 'summary' => '编辑标书内容接口',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:EditBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ExportAnalysisTagDetailByTaskId' => [
+ 'path' => '',
+ 'methods' => ['post', 'get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8329,433 +4334,369 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'Type',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '政务和传媒类别,media:传媒,government:政务',
- 'description' => '政务和传媒类别,media:传媒,government:政务',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'market' => '营销文稿',
- 'government' => '政务文稿',
- 'media' => '传媒文稿',
- 'office' => '办公文稿',
- ],
- 'example' => 'media',
- 'default' => 'media',
- 'enum' => [
- 'media',
- 'government',
- 'custom',
- ],
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
],
[
- 'name' => 'RegionId',
- 'in' => 'query',
+ 'name' => 'Categories',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'type' => 'string',
+ 'title' => '分类筛选列表',
+ 'description' => '分类筛选列表',
+ 'type' => 'array',
+ 'items' => ['title' => '分类筛选', 'description' => '分类筛选', 'type' => 'string', 'required' => false, 'example' => '分类1'],
'required' => false,
],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<List<PromptBuildConfigQueryDO>>',
- 'description' => 'PlainResult<List<PromptBuildConfigQueryDO>>',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务对象',
- 'type' => 'object',
- 'properties' => [
- 'BuildIn' => [
- 'title' => '是否为内置',
- 'description' => '是否为内置',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-04-11 06:14:07',
- ],
- 'CreateUser' => [
- 'title' => '创建用户',
- 'description' => '创建用户',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Id' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '主键ID,内置配置(buildIn=true)无该字段',
- ],
- 'Keywords' => [
- 'title' => '标签可选的值列表',
- 'description' => '标签可选的值列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签可选的值定义',
- 'description' => '标签可选的值定义',
- 'type' => 'object',
- 'properties' => [
- 'Description' => [
- 'title' => '预设标签的描述',
- 'description' => '预设标签的描述',
- 'type' => 'string',
- 'example' => '新闻内容',
- ],
- 'Key' => [
- 'title' => '预设标签的KEY',
- 'description' => '预设标签的KEY',
- 'type' => 'string',
- 'example' => '新闻内容',
- ],
- ],
- ],
- ],
- 'Tag' => [
- 'title' => '标签key值',
- 'description' => '标签key值',
- 'type' => 'string',
- 'example' => 'writingStyle',
- ],
- 'TagDescription' => [
- 'title' => '标签描述',
- 'description' => '标签描述',
- 'type' => 'string',
- 'example' => '文体',
- ],
- 'Type' => [
- 'title' => '区分政务和传媒,media:传媒,government:政务',
- 'description' => '区分政务和传媒,media:传媒,government:政务',
- 'type' => 'string',
- 'example' => 'media',
- ],
- 'UpdateTime' => [
- 'title' => '更新时间',
- 'description' => '更新时间',
- 'type' => 'string',
- 'example' => '2023-04-11 06:14:07'."\n",
- ],
- 'UpdateUser' => [
- 'title' => '更新用户',
- 'description' => '更新用户',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '临时可访问的URL(1小时过期)', 'description' => '临时可访问的URL(1小时过期)', 'type' => 'string', 'example' => 'http://www.example.com/xxx.xlsx'],
+ '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'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"BuildIn\\": true,\\n \\"CreateTime\\": \\"2023-04-11 06:14:07\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"Id\\": 0,\\n \\"Keywords\\": [\\n {\\n \\"Description\\": \\"新闻内容\\",\\n \\"Key\\": \\"新闻内容\\"\\n }\\n ],\\n \\"Tag\\": \\"writingStyle\\",\\n \\"TagDescription\\": \\"文体\\",\\n \\"Type\\": \\"media\\",\\n \\"UpdateTime\\": \\"2023-04-11 06:14:07\\\\n\\",\\n \\"UpdateUser\\": \\"1\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取系统自定义预设',
- ],
- 'GenerateImageTask' => [
- 'summary' => '根据文字异步生成图片。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出标签挖掘结果',
+ 'summary' => '导出企业VOC分析任务明细列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"http://www.example.com/xxx.xlsx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ExportAuditContentResult' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'."\n",
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'ParagraphList',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '段落内容',
- 'description' => '段落内容',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '段落内容',
- 'description' => '段落内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '一直忧伤的猫',
- ],
- 'Id' => [
- 'title' => '段落ID',
- 'description' => '段落ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
- 'TaskId' => [
- 'title' => '任务ID 任务唯一标识',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3',
- ],
- 'TaskStatus' => [
- 'title' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'description' => '当前任务状态 '."\n"
- ."\n"
- .'- PENDING:任务排队中'."\n"
- .'- RUNNING:任务处理中'."\n"
- .'- SUSPENDED:任务挂起'."\n"
- .'- SUCCEEDED:任务执行成功'."\n"
- .'- FAILED:任务执行失败'."\n"
- .'- UNKNOWN:任务不存在或状态未知',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SUCCESSED',
- ],
- ],
- 'required' => false,
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'successful'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => ['title' => '返回word格式的可公开访问的URL(1小时失效)', 'description' => '返回word格式(.docx)的可公开访问的URL(1小时失效)', 'type' => 'string', 'example' => 'http://www.example.com/xxx.docx'],
],
- 'required' => true,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出智能审校报告',
+ 'summary' => '导出智能审核报告',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Style',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '风格 &quot;&lt;photography&gt;&quot;=摄影, &quot;&lt;portrait&gt;&quot;=人像写真, &quot;&lt;3d cartoon&gt;&quot;=3D卡通, &quot;&lt;anime&gt;&quot;=动画, &quot;&lt;oil painting&gt;&quot;=油画, &quot;&lt;watercolor&gt;&quot;=水彩, &quot;&lt;sketch&gt;&quot;=素描, &quot;&lt;chinese painting&gt;&quot;=中国画, &quot;&lt;flat illustration&gt;&quot;=扁平插画, &quot;&lt;auto&gt;&quot;=默认',
- 'description' => '风格',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- '<portrait>' => '人像写真',
- '<auto>' => '默认风格',
- '<3d cartoon>' => '3D卡通',
- 'watercolor' => '水彩',
- '<photography>' => '摄影',
- '<flat illustration>' => '扁平插画',
- '<sketch>' => '素描',
- '<oil painting>' => '油画',
- '<chinese painting>' => '中国画',
- '<anime>' => '动画',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportAuditContentResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'example' => '\'<auto>\'',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"http://www.example.com/xxx.docx\\"\\n}","type":"json"}]',
+ ],
+ 'ExportCustomSourceAnalysisTask' => [
+ 'summary' => '导出-自定义数据源-选题视角分析任务结果',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
- 'name' => 'Size',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '大小 1024*1024\', \'720*1280\', \'1280*720\'',
- 'description' => '生成图片尺寸',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- '1024*1024' => '1024*1024',
- '720*1280' => '720*1280',
- '1280*720' => '1280*720',
- ],
- 'example' => '1024*1024',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'ArticleTaskId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文章taskId',
- 'description' => '文章taskId,如目前没有,可以赋值为UUID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'required' => true, 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2'],
+ ],
+ [
+ 'name' => 'ExportType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '导出格式类型,默认 jsonLine'."\n"
+ .'jsonline: 导出为jsonLine格式'."\n"
+ .'excel:导出为excel格式', 'description' => '导出格式类型,默认 jsonLine'."\n"
+ .'jsonline: 导出为jsonLine格式'."\n"
+ .'excel:导出为excel格式', 'type' => 'string', 'required' => false, 'example' => 'jsonLine'],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<GenerateImageTaskResponse>',
- 'description' => 'PlainResult<GenerateImageTaskResponse>',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskList' => [
- 'title' => '段落任务信息,根据输入的段落ID进行关联',
- 'description' => '段落任务信息,根据输入的段落ID进行关联',
- 'type' => 'array',
- 'items' => [
- 'description' => '段落对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '段落内容',
- 'description' => '段落内容',
- 'type' => 'string',
- 'example' => '一直忧伤的猫',
- ],
- 'Id' => [
- 'title' => '段落ID',
- 'description' => '段落ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TaskId' => [
- 'title' => '任务ID 任务唯一标识',
- 'description' => '任务ID 任务唯一标识',
- 'type' => 'string',
- 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3',
- ],
- 'TaskStatus' => [
- 'title' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'description' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- ],
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '可公网访问的URL', 'description' => '可公网访问的URL', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jsonLine'."\n"],
+ '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'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskList\\": [\\n {\\n \\"Content\\": \\"一直忧伤的猫\\",\\n \\"Id\\": 1,\\n \\"TaskId\\": \\"e1be065b-adc3-435e-bd01-1c18c5ed75d3\\",\\n \\"TaskStatus\\": \\"SUCCESSED\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '生成智能配图任务',
- ],
- 'FetchImageTask' => [
- 'summary' => '获取图片任务执行结果。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出自定义源-话题分析任务结果',
+ 'responseParamsDescription' => '文件返回格式为 jsonLine,每行为一个json对象。json对象格式如下:'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| topic | string | 话题名称 |'."\n"
+ .'| topicSummaryResult | array\\<TopicSummaryResult> | 话题摘要列表'."\n"
+ .'| hotViewPointsResult | HotViewPointsResult | 热门视角分析结果'."\n"
+ .'| timedViewPointsResult | TimedViewPointsResult | 时效性视角分析结果'."\n"
+ .'| webReviewPointsResult | WebReviewPointsResult | 网友视角分析结果'."\n"
+ .'| freshViewPointsResult | FreshViewPointsResult | 新颖视角分析结果'."\n"
+ ."\n"
+ .'## TopicSummaryResult(话题摘要)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| summaries | array\\<SummaryItem> | 话题摘要列表|'."\n"
+ ."\n"
+ .'### SummaryItem(话题摘要)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| title | string | 话题摘要标题 |'."\n"
+ .'| summary | string | 话题摘要内容 |'."\n"
+ .'| docList | array\\<DocItem> | 摘要引用的文档列表 |'."\n"
+ ."\n"
+ .'### DocItem(引用的文档)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| title | string | 文档标题 |'."\n"
+ .'| url | string | 文档链接 |'."\n"
+ .'| source | string | 文档来源 |'."\n"
+ ."\n\n"
+ .'## HotViewPointsResult(热门视角分析结果)'."\n"
+ ."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| attitudes | array\\<HotAttitudeItem> | 热门视角列表|'."\n"
+ ."\n"
+ .'### HotAttitudeItem(热门视角)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| attitude | string | 热门视角 |'."\n"
+ .'| attitudeType | string | 热门视角类型 |'."\n"
+ .'| news | array\\<HotNewsItem> | 热门视角引用的文章列表|'."\n"
+ .'| ratio | string | 该热门视角在整个话题中的占比 |'."\n"
+ .'| viewPoints | array\\<HotViewPointItem> | 热门视角的策划提案列表 |'."\n"
+ ."\n\n"
+ .'### HotNewsItem(热门视角引用的文章)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| title | string | 文章标题 |'."\n"
+ .'| url | string | 文章链接 |'."\n"
+ .'| source | string | 文章来源 |'."\n"
+ ."\n"
+ .'### HotViewPointItem(热门视角选题)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| point | string | 选题策划方向 | '."\n"
+ .'| summary | string | 选题策划方向的概要 |'."\n"
+ .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
+ ."\n"
+ .'### OutlineItem'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| outline | string | 提纲标题 |'."\n"
+ .'| summary | string | 提纲概要 |'."\n"
+ ."\n\n"
+ ."\n\n"
+ ."\n\n"
+ .'## TimedViewPointsResult(时效性视角分析结果)'."\n"
+ ."\n\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| attitudes | array\\<TimedAttitudeItem> | 时效性视角列表|'."\n"
+ ."\n"
+ .'### TimedAttitudeItem(时效性视角)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| docUuid | string | 新闻唯一标识 |'."\n"
+ .'| title | string | 新闻标题 |'."\n"
+ .'| url | string | 新闻链接 |'."\n"
+ .'| source | string | 新闻来源 |'."\n"
+ .'| pubTime | string | 新闻发布时间 |'."\n"
+ .'| viewPoints | array\\<TimedViewPointItem> | 时效性视角的策划提案列表 |'."\n"
+ ."\n"
+ .'### TimedViewPointItem(时效性视角选题)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| point | string | 选题策划方向 |'."\n"
+ .'| summary | string | 选题策划方向的概要 |'."\n"
+ .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
+ ."\n"
+ .'### OutlineItem'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| outline | string | 提纲标题 |'."\n"
+ .'| summary | string | 提纲概要 |'."\n"
+ ."\n\n"
+ .'## WebReviewPointsResult(网友视角分析结果)'."\n"
+ ."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| attitudes | array\\<WebReviewAttitudeItem> | 网友视角列表|'."\n"
+ ."\n"
+ .'### WebReviewAttitudeItem(网友视角)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| attitude | string | 网友视角 |'."\n"
+ .'| attitudeType | string | 网友视角类型 |'."\n"
+ .'| ratio | string | 该网友视角在整个话题中的占比 |'."\n"
+ .'| comments | array\\<WebReviewCommentItem> | 网友评论列表|'."\n"
+ .'| viewPoints | array\\<WebReviewViewPointItem> | 网友视角的策划提案列表 |'."\n"
+ ."\n\n"
+ ."\n"
+ .'### WebReviewCommentItem(网友评论)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| text | string | 网友评论 |'."\n"
+ .'| source | string | 网友评论来源 |'."\n"
+ .'| url | string | 网友评论来源新闻链接 |'."\n"
+ .'| title | string | 网友评论来源新闻标题 |'."\n"
+ ."\n"
+ .'### WebReviewViewPointItem(网友视角选题)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| point | string | 选题策划方向 |'."\n"
+ .'| summary | string | 选题策划方向的概要 |'."\n"
+ .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
+ ."\n"
+ .'### OutlineItem'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| outline | string | 提纲标题 |'."\n"
+ .'| summary | string | 提纲概要 |'."\n"
+ ."\n\n"
+ .'## FreshViewPointsResult()'."\n"
+ ."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| attitudes | array\\<FreshAttitudeItem> | 新颖视角列表|'."\n"
+ ."\n"
+ .'### FreshAttitudeItem(新颖视角)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| viewPoints | array\\<FreshViewPointItem> | 新颖视角的策划提案列表 |'."\n"
+ ."\n"
+ .'### FreshViewPointItem(新颖视角选题)'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| point | string | 选题策划方向 |'."\n"
+ .'| summary | string | 选题策划方向的概要 |'."\n"
+ .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
+ ."\n"
+ .'### OutlineItem'."\n"
+ .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
+ .'| ------------ | ------------ | ------------ |'."\n"
+ .'| outline | string | 提纲标题 |'."\n"
+ .'| summary | string | 提纲概要 |',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportCustomSourceAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"http://www.example.com/xxx.jsonLine\\\\n\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ExportGeneratedContent' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -8763,345 +4704,185 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'TaskIdList',
+ 'name' => 'Id',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '任务ID列表',
- 'description' => '任务ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => 'TaskId,任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '9c5ac65f-fcac-416c-81d0-4ab81e1373fd',
- ],
- 'required' => true,
- 'example' => '["9d8c9185-3f75-4a20-aca1-c5bb53dd97b3"]',
- ],
- ],
- [
- 'name' => 'ArticleTaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文章taskId',
- 'description' => '文章taskId',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3',
- ],
+ 'schema' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<FetchTaskResponse>',
- 'description' => 'PlainResult<FetchTaskResponse>',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskInfoList' => [
- 'title' => '智能配图生成的图片信息',
- 'description' => '智能配图生成的图片信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '段落ID',
- 'description' => '段落ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'ImageList' => [
- 'title' => '图片信息',
- 'description' => '图片信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '如果图片没有生成返回的异常code标识',
- 'description' => '如果图片没有生成返回的异常code标识',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '如果图片没有生成返回的异常信息描述',
- 'description' => '如果图片没有生成返回的异常信息描述',
- 'type' => 'string',
- 'example' => '错误',
- ],
- 'Url' => [
- 'title' => '图片地址',
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'http://www.example.com/aaa.png',
- ],
- ],
- ],
- ],
- 'TaskId' => [
- 'title' => '任务ID 任务唯一标识',
- 'description' => '任务ID 任务唯一标识',
- 'type' => 'string',
- 'example' => 'net-7eb32699000d4193a3c59fc64ae1e55f',
- ],
- 'TaskStatus' => [
- 'title' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'description' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- ],
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'string', 'example' => 'xxx'],
+ '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'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出文档',
+ 'summary' => '导出文档:用来导出妙笔中创作的文章历史。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskInfoList\\": [\\n {\\n \\"Id\\": 1,\\n \\"ImageList\\": [\\n {\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"错误\\",\\n \\"Url\\": \\"http://www.example.com/aaa.png\\"\\n }\\n ],\\n \\"TaskId\\": \\"net-7eb32699000d4193a3c59fc64ae1e55f\\",\\n \\"TaskStatus\\": \\"SUCCESSED\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DD656AF9-0839-521A-A3D2-F320009F9C87\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取图片任务执行结果',
- ],
- 'FeedbackDialogue' => [
- 'summary' => '反馈模型生成的内容质量。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportGeneratedContent'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"xxx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ExportHotTopicPlanningProposals' => [
+ 'summary' => '导出选题策划文档,响应为一个可公开访问的URL。一小时后失效。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ExportType',
'in' => 'formData',
- 'schema' => [
- 'title' => '整个页面的ID',
- 'description' => '整个页面的ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '导出文档类型,word:导出为word,xmind:导处为xmind', 'description' => '导出文档类型'."\n"
+ ."\n"
+ .'- word:导出为word'."\n"
+ ."\n"
+ .'- xmind:导处为xmind', 'type' => 'string', 'required' => false, 'example' => 'word'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Titles',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '单轮对话的ID',
- 'description' => '单轮对话的ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '75bf82fa-b71b-45d7-ae40-0b00e496cd9e',
+ 'title' => '根据选题策划的标题过滤',
+ 'description' => '根据选题策划的标题过滤',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => '选题策划标题过滤', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'required' => false,
],
],
[
- 'name' => 'Rating',
+ 'name' => 'ViewPointType',
'in' => 'formData',
- 'schema' => [
- 'title' => 'thumbsDown:点踩、thumbsUp:点赞',
- 'description' => 'thumbsDown:点踩、thumbsUp:点赞',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'thumbsDown' => '点踩',
- 'thumbsUp' => '点赞',
- ],
- 'example' => 'thumbsDown',
- ],
+ 'schema' => ['title' => '选题策划类型:CustomViewPoints:自定义视角,HotViewPoints:热门视角、TimedViewPoints:时效性视角、WebReviewPoints:网友视角、FreshViewPoints:新颖视角', 'description' => '选题策划类型'."\n"
+ ."\n"
+ .'- CustomViewPoints:自定义视角'."\n"
+ ."\n"
+ .'- HotViewPoints:热门视角'."\n"
+ ."\n"
+ .'- TimedViewPoints:时效性视角'."\n"
+ ."\n"
+ .'- WebReviewPoints:网友视角'."\n"
+ ."\n"
+ .'- FreshViewPoints:新颖视角', 'type' => 'string', 'required' => false, 'example' => 'CustomViewPoints'],
],
[
- 'name' => 'RatingTags',
+ 'name' => 'CustomViewPointIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '标签',
- 'description' => '标签',
+ 'title' => '自定义视角ID(用于自定义视角选题策划场景)',
+ 'description' => '自定义视角ID(用于自定义视角选题策划场景)',
'type' => 'array',
- 'items' => [
- 'description' => '反馈标签,任意字符,长度小于20字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '生成内容跟要求不符(跟主题不符)',
- ],
+ 'items' => ['title' => '自定义视角ID(用于自定义视角选题策划场景)', 'description' => '自定义视角ID(用于自定义视角选题策划场景)', 'type' => 'string', 'required' => false, 'example' => '7d9139c4fd884be3b5db584c28501813'],
'required' => false,
+ 'example' => '025c6cee437741368098b790c90166f8',
],
],
[
- 'name' => 'ModifiedResponse',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '客户修改后的生成结果',
- 'description' => '修改后的生成结果',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
- ],
- [
- 'name' => 'CustomerResponse',
+ 'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户反馈信息',
- 'description' => '反馈信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['title' => '热榜源', 'description' => '热榜源', 'type' => 'string', 'required' => true, 'example' => '热榜源'],
],
[
- 'name' => 'GoodText',
+ 'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '客户认为好的生成内容',
- 'description' => '认为好的生成内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test',
- ],
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => true, 'example' => '热榜主题'],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'BaseResult',
- 'description' => 'BaseResult',
+ 'title' => '',
+ 'description' => '',
'type' => 'object',
'properties' => [
- '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',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '可公开访问的URL。一小时后失效', 'description' => '可公开访问的URL。一小时后失效', 'type' => 'string', 'example' => '业务数据'],
+ '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'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '反馈对话',
- ],
- 'ListStyleLearningResult' => [
- 'summary' => '获取文体学习分析结果列表。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出选题策划文档',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportHotTopicPlanningProposals',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"业务数据\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ExportIntervenes' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9109,170 +4890,71 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'Current',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'Size',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fed6555ec9e24b92aeecc34be484b887_p_efm'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PageResult',
- 'description' => 'PageResult',
+ 'title' => 'PlainResult<UrlResult>',
+ 'description' => 'PlainResult<UrlResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Current' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
'Data' => [
- 'description' => '文体学习分析结果集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'AigcResult' => [
- 'title' => 'AIGC 生成的内容',
- 'description' => 'AIGC 生成的内容',
- 'type' => 'string',
- 'example' => 'AIGC 生成的内容',
- ],
- 'Id' => [
- 'title' => '文体学习分析结果ID',
- 'description' => '文体学习分析结果ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '70',
- ],
- 'RewriteResult' => [
- 'title' => '用户修订后内容',
- 'description' => '用户修订后内容',
- 'type' => 'string',
- 'example' => '用户修订后内容',
- ],
- 'StyleName' => [
- 'title' => '文体风格名称',
- 'description' => '文体风格名称',
- 'type' => 'string',
- 'example' => '文体风格名称',
- ],
- 'TaskId' => [
- 'title' => '文体分析时的任务ID',
- 'description' => '文体分析时的任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- ],
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileUrl' => ['title' => '文件url', 'description' => '文件url', 'type' => 'string', 'example' => 'http://xxx/xxx.xls'],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
],
- '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',
- ],
- 'Size' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'title' => '总记录条数',
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ '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'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出干预项内容',
+ 'summary' => '导出所有干预内容。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"AigcResult\\": \\"AIGC 生成的内容\\",\\n \\"Id\\": 70,\\n \\"RewriteResult\\": \\"用户修订后内容\\",\\n \\"StyleName\\": \\"文体风格名称\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
- 'title' => '获取文体学习分析结果列表',
- ],
- 'RunStyleFeatureAnalysis' => [
- 'summary' => '内容特点分析。',
- 'path' => '/quanmiao/aimiaobi/runStyleFeatureAnalysis',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportIntervenes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://xxx/xxx.xls\\",\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ExportPptArtifact' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9280,61 +4962,46 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间id',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxx'],
],
[
- 'name' => 'Contents',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '自定义内容文本集合',
- 'description' => '自定义内容文本集合',
- 'type' => 'array',
- 'items' => [
- 'title' => '自定义内容文本',
- 'description' => '自定义内容文本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '生活是一种律动,须有光有影,有左有右,有晴有雨,趣味就在这变而不猛的曲折里,微微暗些,再明起来,则暗得有趣,而明乃更明。——老舍',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'example' => 'abc'],
],
[
- 'name' => 'MaterialIds',
+ 'name' => 'PptArtifactId',
+ 'in' => 'formData',
+ 'schema' => ['title' => 'PPT作品ID', 'description' => 'PPT作品ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123'],
+ ],
+ [
+ 'name' => 'ExportFileType',
'in' => 'formData',
- 'style' => 'json',
'schema' => [
- 'title' => '素材库ID集合',
- 'description' => '素材库ID集合',
- 'type' => 'array',
- 'items' => [
- 'title' => '素材库ID',
- 'description' => '素材库ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'title' => '导出格式',
+ 'description' => '导出格式',
+ 'type' => 'string',
'required' => false,
+ 'example' => 'ppt',
+ 'default' => 'ppt',
+ 'enum' => ['ppt', 'png', 'jpeg', 'pdf'],
],
],
+ [
+ 'name' => 'Edit',
+ 'in' => 'formData',
+ 'schema' => ['title' => '导出的作品是否可编辑', 'description' => '导出的作品是否可编辑', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Zip',
+ 'in' => 'formData',
+ 'schema' => ['title' => '导出的图片是否压缩为zip', 'description' => '导出的图片是否压缩为zip', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
],
'responses' => [
200 => [
@@ -9343,141 +5010,48 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'End' => [
- 'title' => '输出是否完成,true 表示完成',
- 'description' => '输出是否完成,true 表示完成',
- 'type' => 'boolean',
- ],
- 'Header' => [
- 'title' => '流式输出 header 头,包含返回通用信息',
- 'description' => '流式输出 header 头,包含返回通用信息',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ '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' => '模型生成事件',
- ],
- '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',
- ],
+ 'ExportTaskId' => ['title' => '导出任务的Key', 'description' => '导出任务的Key', 'type' => 'string', 'example' => 'adb8146b-146b-4206-bd40-19f591e85293'],
],
],
- 'Payload' => [
- 'title' => '返回结果的 payload,json 结构',
- 'description' => '返回结果的 payload,json 结构',
- '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' => '总oken数量',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求唯一ID',
- 'description' => '请求唯一ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '导出PPT作品',
+ 'summary' => '导出PPT作品',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportPptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
- 'title' => '内容特点分析',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"ExportTaskId\\": \\"adb8146b-146b-4206-bd40-19f591e85293\\"\\n }\\n}","type":"json"}]',
],
- 'SaveStyleLearningResult' => [
- 'summary' => '保存自定义文体。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'FeedbackDialogue' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9485,277 +5059,252 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'RewriteResult',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public'],
+ ],
+ [
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户修订后内容',
- 'description' => '用户修订后内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户修订后内容',
- ],
+ 'schema' => ['title' => '整个页面的ID', 'description' => '整个页面的ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'StyleName',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户修订后内容',
- 'description' => '保存后的文体名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '学习报告',
- ],
+ 'schema' => ['title' => '单轮对话的ID', 'description' => '单轮对话的ID', 'type' => 'string', 'required' => true, 'example' => '75bf82fa-b71b-45d7-ae40-0b00e496cd9e'],
],
[
- 'name' => 'AigcResult',
+ 'name' => 'Rating',
'in' => 'formData',
'schema' => [
- 'title' => 'AIGC 生成的内容',
- 'description' => 'AIGC 生成的内容',
+ 'title' => 'thumbsDown:点踩、thumbsUp:点赞',
+ 'description' => 'thumbsDown:点踩、thumbsUp:点赞',
'type' => 'string',
'required' => false,
- 'example' => 'AIGC 生成的内容',
+ 'enumValueTitles' => ['thumbsDown' => '点踩', 'thumbsUp' => '点赞'],
+ 'example' => 'thumbsDown',
],
],
[
- 'name' => 'CustomTextIdList',
+ 'name' => 'RatingTags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '自定义素材ID',
- 'description' => '自定义文本素材集合',
+ 'title' => '标签',
+ 'description' => '标签',
'type' => 'array',
- 'items' => [
- 'description' => '1',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '18',
- ],
+ 'items' => ['description' => '反馈标签,任意字符,长度小于20字', 'type' => 'string', 'required' => false, 'example' => '生成内容跟要求不符(跟主题不符)'],
'required' => false,
],
],
[
- 'name' => 'AgentKey',
+ 'name' => 'ModifiedResponse',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '客户修改后的生成结果', 'description' => '修改后的生成结果', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'CustomerResponse',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务id 和SSE接口中的taskID 保持一致',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '客户反馈信息', 'description' => '反馈信息', 'type' => 'string', 'required' => false, 'example' => 'test'],
],
[
- 'name' => 'MaterialIdList',
+ 'name' => 'GoodText',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '客户认为好的生成内容', 'description' => '认为好的生成内容', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '素材ID集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '1',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '4',
+ 'title' => 'BaseResult',
+ 'description' => 'BaseResult',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '反馈对话',
+ 'summary' => '反馈模型生成的内容质量。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FeedbackDialogue'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FeedbackDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'FetchExportTermsTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文件FileKey', 'description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
'responses' => [
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'PlainResult',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileUrl' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'https//xxxx'],
+ 'Status' => ['title' => '任务执行状态', 'description' => '任务执行状态', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消'],
+ ],
],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取导出词库任务结果',
+ 'summary' => '获取词库导出任务结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchExportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '保存文体学习分析结果',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https//xxxx\\",\\n \\"Status\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n }\\n}","type":"json"}]',
],
- 'DeleteStyleLearningResult' => [
- 'summary' => '删除指定自定义文体。',
+ 'FetchExportWordTask' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'Id',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文体学习ID',
- 'description' => '文体学习ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '20',
- ],
+ 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '2e27abb32cb64f80a0c6e829b6c87a09'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'xxx',
- ],
- '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',
+ 'description' => '返回数据。',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileUrl' => ['description' => '文件url', 'type' => 'string', 'example' => 'http://xxx/xxx.xls'],
+ 'TaskStats' => ['description' => '任务状态', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消'],
+ ],
],
+ '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'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除自定义文体',
- ],
- 'GetStyleLearningResult' => [
- 'summary' => '获取文体学习分析结果。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取导出文档任务结果',
+ 'summary' => '获取异步导出文档任务结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchExportWordTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://xxx/xxx.xls\\",\\n \\"TaskStats\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'FetchImageTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9763,360 +5312,118 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'],
],
[
- 'name' => 'Id',
+ 'name' => 'TaskIdList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '文体学习ID',
- 'description' => '文体学习ID',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '任务ID列表',
+ 'description' => '任务ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => 'TaskId,任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '9c5ac65f-fcac-416c-81d0-4ab81e1373fd'],
'required' => true,
- 'example' => '39',
+ 'example' => '["9d8c9185-3f75-4a20-aca1-c5bb53dd97b3"]',
],
],
+ [
+ 'name' => 'ArticleTaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文章taskId', 'description' => '文章taskId', 'type' => 'string', 'required' => true, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PlainResult<FetchTaskResponse>',
+ 'description' => 'PlainResult<FetchTaskResponse>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'AigcResult' => [
- 'title' => 'AIGC 生成的内容',
- 'description' => 'AIGC 生成的内容',
- 'type' => 'string',
- 'example' => 'AIGC 生成的内容',
- ],
- 'ContentList' => [
- 'title' => '自定义内容实体内容',
- 'description' => '自定义内容实体内容',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义内容',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '内容',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '创建时间',
- ],
- 'CreateUser' => [
- 'title' => '创建用户',
- 'description' => '创建用户',
- 'type' => 'string',
- 'example' => '创建用户',
- ],
- 'Id' => [
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '修改时间',
- ],
- 'UpdateUser' => [
- 'title' => '修改用户',
- 'description' => '修改用户',
- 'type' => 'string',
- 'example' => '修改用户',
- ],
- ],
- ],
- ],
- 'CustomTextIdList' => [
- 'title' => '自定义内容ID集合',
- 'description' => '自定义内容ID集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义内容ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '25',
- ],
- ],
- 'Id' => [
- 'title' => '文体学习分析结果ID',
- 'description' => '文体学习分析结果ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '33',
- ],
- 'MaterialIdList' => [
- 'title' => '素材ID集合',
- 'description' => '素材ID集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '素材库ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '4',
- ],
- ],
- 'MaterialInfoList' => [
- 'title' => '素材详细信息',
- 'description' => '素材详细信息',
+ 'TaskInfoList' => [
+ 'title' => '智能配图生成的图片信息',
+ 'description' => '智能配图生成的图片信息',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '创建时间',
- ],
- 'CreateUser' => [
- 'title' => '创建用户ID',
- 'description' => '创建用户ID',
- 'type' => 'string',
- 'example' => '创建用户ID',
- ],
- 'CreateUserName' => [
- 'title' => '创建用户姓名',
- 'description' => '创建用户姓名',
- 'type' => 'string',
- 'example' => '创建用户姓名',
- ],
- 'DocKeywords' => [
- 'title' => '文档标签用于分类等、不同keyword之间逗号分割',
- 'description' => '文档标签用于分类等、不同keyword之间逗号分割',
+ 'Id' => ['title' => '段落ID', 'description' => '段落ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ImageList' => [
+ 'title' => '图片信息',
+ 'description' => '图片信息',
'type' => 'array',
'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'example' => '中欧',
- ],
- ],
- 'DocType' => [
- 'title' => '文档类型,pdf、word、url、image',
- 'description' => '文档类型,pdf、word、url、image',
- 'type' => 'string',
- 'example' => '文档类型,pdf、word、url、image',
- ],
- 'ExternalUrl' => [
- 'title' => '外部客户上传的URL,仅用作记录保存',
- 'description' => '外部客户上传的URL,仅用作记录保存',
- 'type' => 'string',
- 'example' => '外部客户上传的URL,仅用作记录保存',
- ],
- 'FileLength' => [
- 'title' => '文件内容长度',
- 'description' => '文件内容长度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '41',
- ],
- 'HtmlContent' => [
- 'title' => '解析后的原始html内容',
- 'description' => '解析后的原始html内容',
- 'type' => 'string',
- 'example' => '解析后的原始html内容',
- ],
- 'Id' => [
- 'title' => '主键',
- 'description' => '主键',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '发布时间',
- ],
- 'PublicUrl' => [
- 'title' => '临时的对外公开的URL',
- 'description' => '临时的对外公开的URL',
- 'type' => 'string',
- 'example' => '临时的对外公开的URL',
- ],
- 'ShareAttr' => [
- 'title' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
- 'description' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '如果图片没有生成返回的异常code标识', 'description' => '如果图片没有生成返回的异常code标识', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '如果图片没有生成返回的异常信息描述', 'description' => '如果图片没有生成返回的异常信息描述', 'type' => 'string', 'example' => '错误'],
+ 'Url' => ['title' => '图片地址', 'description' => '图片地址', 'type' => 'string', 'example' => 'http://www.example.com/aaa.png'],
+ ],
+ 'description' => '',
],
],
- 'SrcFrom' => [
- 'title' => '文档来源,user_upload、search、viewpoint',
- 'description' => '文档来源,user_upload、search、viewpoint',
- 'type' => 'string',
- 'example' => '文档来源,user_upload、search、viewpoint',
- ],
- 'Summary' => [
- 'title' => '文档摘要',
- 'description' => '文档摘要',
- 'type' => 'string',
- 'example' => '文档摘要',
- ],
- 'TextContent' => [
- 'title' => '解析后的文本内容,对于图片来说为空',
- 'description' => '解析后的文本内容,对于图片来说为空',
- 'type' => 'string',
- 'example' => '解析后的文本内容,对于图片来说为空',
- ],
- 'ThumbnailInBase64' => [
- 'title' => '图片文档类型的Base64缩略图',
- 'description' => '图片文档类型的Base64缩略图',
- 'type' => 'string',
- 'example' => '图片文档类型的Base64缩略图',
- ],
- 'Title' => [
- 'title' => '文档标题',
- 'description' => '文档标题',
- 'type' => 'string',
- 'example' => '文档标题',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '修改时间',
- ],
- 'UpdateUser' => [
- 'title' => '修改用户ID',
- 'description' => '修改用户ID',
- 'type' => 'string',
- 'example' => '修改用户ID',
- ],
- 'UpdateUserName' => [
- 'title' => '修改用户姓名',
- 'description' => '修改用户姓名',
- 'type' => 'string',
- 'example' => '修改用户姓名',
- ],
- 'Url' => [
- 'title' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除',
- 'description' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除',
- 'type' => 'string',
- 'example' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除',
- ],
+ 'TaskId' => ['title' => '任务ID 任务唯一标识', 'description' => '任务ID 任务唯一标识', 'type' => 'string', 'example' => 'net-7eb32699000d4193a3c59fc64ae1e55f'],
+ 'TaskStatus' => ['title' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中', 'description' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中', 'type' => 'string', 'example' => 'SUCCESSED'],
],
+ 'description' => '',
],
],
- 'RewriteResult' => [
- 'title' => '用户修订后内容',
- 'description' => '用户修订后内容',
- 'type' => 'string',
- 'example' => '用户修订后内容',
- ],
- 'StyleName' => [
- 'title' => '文体风格名称',
- 'description' => '用户修订后内容',
- 'type' => 'string',
- 'example' => '用户修订后内容',
- ],
- 'TaskId' => [
- 'title' => '文体分析时的任务ID',
- 'description' => '文体分析时的任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取图片任务执行结果',
+ 'summary' => '获取图片任务执行结果。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"MaterialIdList\\": [\\n 4\\n ],\\n \\"CustomTextIdList\\": [\\n 25\\n ],\\n \\"ContentList\\": [\\n {\\n \\"Id\\": 1,\\n \\"Title\\": \\"标题\\",\\n \\"Content\\": \\"内容\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"CreateUser\\": \\"创建用户\\",\\n \\"UpdateUser\\": \\"修改用户\\"\\n }\\n ],\\n \\"MaterialInfoList\\": [\\n {\\n \\"Id\\": 50,\\n \\"DocType\\": \\"文档类型,pdf、word、url、image\\",\\n \\"Title\\": \\"文档标题\\",\\n \\"Summary\\": \\"文档摘要\\",\\n \\"Author\\": \\"作者\\",\\n \\"PubTime\\": \\"发布时间\\",\\n \\"DocKeywords\\": [\\n \\"中欧\\"\\n ],\\n \\"Url\\": \\"内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除\\",\\n \\"PublicUrl\\": \\"临时的对外公开的URL\\",\\n \\"ExternalUrl\\": \\"外部客户上传的URL,仅用作记录保存\\",\\n \\"SrcFrom\\": \\"文档来源,user_upload、search、viewpoint\\",\\n \\"TextContent\\": \\"解析后的文本内容,对于图片来说为空\\",\\n \\"HtmlContent\\": \\"解析后的原始html内容\\",\\n \\"ShareAttr\\": 1,\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"CreateUser\\": \\"创建用户ID\\",\\n \\"CreateUserName\\": \\"创建用户姓名\\",\\n \\"UpdateUser\\": \\"修改用户ID\\",\\n \\"UpdateUserName\\": \\"修改用户姓名\\",\\n \\"ThumbnailInBase64\\": \\"图片文档类型的Base64缩略图\\",\\n \\"FileLength\\": 41\\n }\\n ],\\n \\"Id\\": 33,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"AigcResult\\": \\"AIGC 生成的内容\\",\\n \\"RewriteResult\\": \\"用户修订后内容\\",\\n \\"StyleName\\": \\"用户修订后内容\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取文体学习分析结果',
- ],
- 'ListWritingStyles' => [
- 'summary' => '获取文体列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FetchImageTask'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchImageTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskInfoList\\": [\\n {\\n \\"Id\\": 1,\\n \\"ImageList\\": [\\n {\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"错误\\",\\n \\"Url\\": \\"http://www.example.com/aaa.png\\"\\n }\\n ],\\n \\"TaskId\\": \\"net-7eb32699000d4193a3c59fc64ae1e55f\\",\\n \\"TaskStatus\\": \\"SUCCESSED\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DD656AF9-0839-521A-A3D2-F320009F9C87\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'FetchImportTermsTask' => [
+ 'summary' => '获取导入词库任务结果',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10124,63 +5431,86 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxxx',
- ],
+ 'in' => 'formData',
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Scene',
+ 'name' => 'TaskId',
'in' => 'formData',
+ 'schema' => ['title' => '文件FileKey', 'description' => '文件FileKey', 'type' => 'string', 'required' => true, 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '写作场景筛选',
- 'description' => '写作场景筛选',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'market' => '营销写作',
- 'government' => '法定公文 ',
- 'custom' => '自定义写作',
- 'media' => '传媒类',
- 'office' => '事务公文',
+ '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '任务执行状态', 'description' => '任务执行状态', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消'],
+ ],
+ ],
],
- 'example' => 'media',
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取导入词库任务结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'MaxResults',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '返回的最大结果数',
- 'description' => '返回的最大结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchImportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'FetchParseDocumentLayoutTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NextToken',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '写一页Token',
- 'description' => '写一页Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页token',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待排版内容', 'description' => '待排版内容', 'type' => 'string', 'required' => true, 'example' => '29ae0ba84c1c4cc694d0f4f1aead8005'],
],
],
'responses' => [
@@ -10190,102 +5520,48 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'TotalCount' => [
- 'title' => '总记录数',
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '58',
- ],
- 'MaxResults' => [
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'NextToken' => [
- 'title' => '下一个token',
- 'description' => '下一个token',
- 'type' => 'string',
- 'example' => '下一页token',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'string',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['description' => '调用是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '文体列表',
- 'description' => '文体列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '文体对象',
- 'description' => '文体对象',
- 'type' => 'object',
- 'properties' => [
- 'StyleName' => [
- 'title' => '文体名称',
- 'description' => '文体名称',
- 'type' => 'string',
- 'example' => '文体名称',
- ],
- 'StyleKey' => [
- 'title' => '文体唯一标识KEY',
- 'description' => '文体唯一标识KEY',
- 'type' => 'string',
- 'example' => '文体唯一标识',
- ],
- 'StyleDescription' => [
- 'title' => '文体描述',
- 'description' => '文体描述',
- 'type' => 'string',
- 'example' => '文体描述',
- ],
- 'DistributeWriting' => [
- 'title' => '是否支持分步骤写作',
- 'description' => '是否支持分步骤写作',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'StyleImage' => [
- 'title' => '文体图片',
- 'description' => '文体图片',
- 'type' => 'string',
- 'example' => '文体图片'."\n"
- ."\n",
- ],
- 'Emoji' => [
- 'title' => '文体小图标(字符符号表示)',
- 'description' => '文体小图标(字符符号表示)',
- 'type' => 'string',
- 'example' => '小图标',
- ],
- 'TemplateDefine' => [
- 'description' => '文体模板定义',
- '$ref' => '#/components/schemas/WritingStyleTemplateDefine',
- ],
- 'DistributeStepTemplateDefine' => [
- 'description' => '分步骤模板定义',
- '$ref' => '#/components/schemas/WritingStyleTemplateDefine',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskStats' => ['description' => '任务状态', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消'],
+ 'LayoutResult' => [
+ 'description' => '排版后的结构化内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'Elements' => [
+ 'description' => '返回元素数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数组对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Index' => ['description' => '各个元素的索引顺序', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'Type' => ['description' => 'type类型', 'type' => 'string', 'example' => '支持的类型如下'."\n"
+ .' HEADING("标题"),'."\n"
+ .' H1("一级标题"),'."\n"
+ .' H2("二级标题"),'."\n"
+ .' H3("三级标题"),'."\n"
+ .' H4("四级标题"),'."\n"
+ .' H5("五级标题"),'."\n"
+ .' H6("六级标题"),'."\n"
+ .' PARAGRAPH("段落"),'."\n"
+ .' SIGNATURE("落款"),'."\n"
+ .' FOOTNOTE("脚注"),'."\n"
+ .' TABLE("表格"),'."\n"
+ .' CODE_BLOCK("代码块"),'."\n"
+ .' ATTACHMENT("附件"),'."\n"
+ .' BLOCKQUOTE("引用");'],
+ 'Content' => ['description' => '内容', 'type' => 'string', 'example' => '一、本月主要工作进展\\n'],
+ 'FormatContent' => ['description' => '针对标题,去除标题数字标好后的内容', 'type' => 'string', 'example' => '本月主要工作进展'],
+ ],
+ ],
+ ],
],
],
],
@@ -10294,346 +5570,308 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取排版任务结果',
+ 'summary' => '获取排版任务结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"TotalCount\\": 58,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"下一页token\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"数据不存在\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"StyleName\\": \\"文体名称\\",\\n \\"StyleKey\\": \\"文体唯一标识\\",\\n \\"StyleDescription\\": \\"文体描述\\",\\n \\"DistributeWriting\\": false,\\n \\"StyleImage\\": \\"文体图片\\\\n\\\\n\\",\\n \\"Emoji\\": \\"小图标\\",\\n \\"TemplateDefine\\": {\\n \\"Fields\\": [\\n {\\n \\"MinItemLength\\": 0,\\n \\"Max\\": 0,\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"MaxItemLength\\": 0,\\n \\"Name\\": \\"\\",\\n \\"BuildIn\\": true,\\n \\"Enums\\": [\\n {\\n \\"CascadingFields\\": [\\n \\"\\"\\n ],\\n \\"Key\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Min\\": 0,\\n \\"Required\\": true,\\n \\"MaxItem\\": 0,\\n \\"InitialValue\\": \\"\\",\\n \\"CascadingFields\\": [\\n {\\n \\"MinItemLength\\": 0,\\n \\"Max\\": 0,\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"MaxItemLength\\": 0,\\n \\"Name\\": \\"\\",\\n \\"BuildIn\\": true,\\n \\"Enums\\": [\\n {\\n \\"CascadingFields\\": [\\n \\"\\"\\n ],\\n \\"Key\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Min\\": 0,\\n \\"Required\\": true,\\n \\"MaxItem\\": 0,\\n \\"InitialValue\\": \\"\\",\\n \\"CascadingFields\\": [\\n {\\n \\"MinItemLength\\": 0,\\n \\"Max\\": 0,\\n \\"MinLength\\": 0,\\n \\"MaxLength\\": 0,\\n \\"MaxItemLength\\": 0,\\n \\"Name\\": \\"\\",\\n \\"BuildIn\\": true,\\n \\"Enums\\": [\\n {\\n \\"CascadingFields\\": [\\n \\"\\"\\n ],\\n \\"Key\\": \\"\\",\\n \\"Name\\": \\"\\"\\n }\\n ],\\n \\"Min\\": 0,\\n \\"Required\\": true,\\n \\"MaxItem\\": 0,\\n \\"InitialValue\\": \\"\\",\\n \\"CascadingFields\\": [],\\n \\"Style\\": {\\n \\"Placeholder\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"ShowTime\\": true,\\n \\"Suffix\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Format\\": \\"\\"\\n },\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Style\\": {\\n \\"Placeholder\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"ShowTime\\": true,\\n \\"Suffix\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Format\\": \\"\\"\\n },\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Style\\": {\\n \\"Placeholder\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"ShowTime\\": true,\\n \\"Suffix\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"Format\\": \\"\\"\\n },\\n \\"Key\\": \\"\\"\\n }\\n ],\\n \\"Example\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ]\\n },\\n \\"DistributeStepTemplateDefine\\": {\\n \\"Fields\\": [],\\n \\"Example\\": [\\n {\\n \\"Value\\": \\"\\",\\n \\"Key\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取写作文体列表',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskStats\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\",\\n \\"LayoutResult\\": {\\n \\"Elements\\": [\\n {\\n \\"Index\\": 1,\\n \\"Type\\": \\"支持的类型如下\\\\n HEADING(\\\\\\"标题\\\\\\"),\\\\n H1(\\\\\\"一级标题\\\\\\"),\\\\n H2(\\\\\\"二级标题\\\\\\"),\\\\n H3(\\\\\\"三级标题\\\\\\"),\\\\n H4(\\\\\\"四级标题\\\\\\"),\\\\n H5(\\\\\\"五级标题\\\\\\"),\\\\n H6(\\\\\\"六级标题\\\\\\"),\\\\n PARAGRAPH(\\\\\\"段落\\\\\\"),\\\\n SIGNATURE(\\\\\\"落款\\\\\\"),\\\\n FOOTNOTE(\\\\\\"脚注\\\\\\"),\\\\n TABLE(\\\\\\"表格\\\\\\"),\\\\n CODE_BLOCK(\\\\\\"代码块\\\\\\"),\\\\n ATTACHMENT(\\\\\\"附件\\\\\\"),\\\\n BLOCKQUOTE(\\\\\\"引用\\\\\\");\\",\\n \\"Content\\": \\"一、本月主要工作进展\\\\\\\\n\\",\\n \\"FormatContent\\": \\"本月主要工作进展\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]',
],
- 'SubmitAuditNote' => [
- 'summary' => '妙笔为您提供了与公有云“智能审校”模块中相同的上传自定义规则库的功能。由于鉴权限制,用户需要使用自定义规则库文件的 fileKey 作为入参才能顺利调用本接口。该接口在被调用后,会对用户的自定义规则库进行结构化处理,并生成一个 xlsx 格式的结构化解析结果。您可以调用 GetAuditNoteProcessingStatus 接口查询结构化处理状态,也可以调用 DownloadAuditNote 接口获取结构化之后的规则库。接口功能正在迭代中,预计会在未来使用可访问的文件 URL 作为入参。',
+ 'GenerateExportWordTask' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'FileKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云 OSS 存储中,用户上传的规则库文件对应的 FileKey。规则库文件只允许使用 docx, xlsx, pdf 格式,其中 xlsx 格式限制两列,且表头必须为“审校依据”和“依据出处”。上传 xlsx 格式能有更好的解析效果,但 docx 和 pdf 也会由系统自动解析。',
- 'description' => '阿里云 OSS 存储中,用户上传的规则库文件对应的 FileKey(注意:FileKey 生成方式见 [通用接口-文件上传下载GenerateUploadConfig - 生成上传配置](https://next.api.aliyun.com/document/AiMiaoBi/2023-08-01/GenerateUploadConfig?spm=openapi-amp.newDocPublishment.0.0.18fc281fOiiBil))。规则库文件只允许使用 docx, xlsx, pdf 格式,其中 xlsx 格式限制两列,且表头必须为“审校依据”和“依据出处”。上传 xlsx 格式能有更好的解析效果,但 docx 和 pdf 也会由系统自动解析。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://default/your/file/key',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'NoteId',
+ 'name' => 'GeneratedContentId',
'in' => 'formData',
- 'schema' => [
- 'title' => '规则库ID(不填默认是 Default )',
- 'description' => '规则库ID(不填默认是 Default )',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
],
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '本次提交规则库的任务 ID(taskId / TaskId),供之后的接口调用使用。',
- 'description' => '本次提交规则库的任务 ID(taskId / TaskId),供之后的接口调用使用。',
- 'type' => 'string',
- 'example' => 'xxx_Default_89123748917',
+ 'description' => '返回内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"xxx_Default_89123748917\\"\\n}","type":"json"}]',
- 'title' => '提交自定义规则库',
- ],
- 'ConfirmAndPostProcessAuditNote' => [
- 'summary' => '是否将本次提交自定义规则库得到的解析结果用于审核任务。由于解析结果可能不满足用户需求,因此我们为您提供了该接口用于二次确认。如果对提交的规则库解析满意,则可以直接将本次提交任务的 TaskId 作为入参,系统会对您上传的规则库做后处理,使它可以被用于审核。反之,您可以重新调用 SubmitAuditNote 接口上传修改之后的规则库。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成导出文档任务',
+ 'summary' => '生成内容导出文档任务',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateExportWordTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GenerateFileUrlByKey' => [
+ 'summary' => '生成临时可访问的公开url。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'FileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '文件key。格式为:protocol://serverInstance/bucketPath/fileKey', 'description' => '文件key。格式为:protocol://serverInstance/bucketPath/fileKey', 'type' => 'string', 'required' => false, 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'FileName',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。',
- 'description' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx_Default_1241541251241',
- ],
+ 'schema' => ['description' => '文件名称', 'type' => 'string', 'required' => false, 'example' => 'test.docx'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<URL>',
+ 'description' => 'PlainResult<URL>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Data' => [
- 'title' => '确认使用该解析结果后得到的任务 ID。实际上与入参一致,在这里返回是为了方便您取值。',
- 'description' => '确认使用该解析结果后得到的任务 ID。实际上与入参一致,在这里返回是为了方便您取值。',
- 'type' => 'string',
- 'example' => '33',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'string', 'example' => 'https://www.example.com/a.txt'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成文件URL',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-03-04T09:44:15.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"33\\"\\n}","type":"json"}]',
- 'title' => '确认提交规则库用于审核',
- ],
- 'DownloadAuditNote' => [
- 'summary' => '您可以通过调用该接口下载结构化后的规则库,供您进行进一步处理。该接口同时拥有两个功能:下载未后处理的结构化规则库,或下载当前可用于审核的结构化规则库。具体使用方法,请参考入参说明。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateFileUrlByKey'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateFileUrlByKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": \\"https://www.example.com/a.txt\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GenerateImageTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'."\n"],
+ ],
+ [
+ 'name' => 'ParagraphList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
+ 'title' => '段落内容',
+ 'description' => '段落内容',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '段落内容', 'description' => '段落内容', 'type' => 'string', 'required' => true, 'example' => '一直忧伤的猫'],
+ 'Id' => ['title' => '段落ID', 'description' => '段落ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ 'TaskId' => ['title' => '任务ID 任务唯一标识', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'],
+ 'TaskStatus' => ['title' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中', 'description' => '当前任务状态 '."\n"
+ ."\n"
+ .'- PENDING:任务排队中'."\n"
+ .'- RUNNING:任务处理中'."\n"
+ .'- SUSPENDED:任务挂起'."\n"
+ .'- SUCCEEDED:任务执行成功'."\n"
+ .'- FAILED:任务执行失败'."\n"
+ .'- UNKNOWN:任务不存在或状态未知', 'type' => 'string', 'required' => false, 'example' => 'SUCCESSED'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => true,
- 'example' => 'llm-xx',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Style',
'in' => 'formData',
'schema' => [
- 'title' => '用户通过 SubmitAuditNote 接口得到的 taskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。'."\n"
- .'在您使用本接口时,如果在入参中包含 taskId,能获取到您已通过 SubmitAuditNote 接口上传成功,但未通过 ConfirmAndProcessAuditNote 进行后处理的结构化规则库;而入参中不包含 taskId 时,则能获取到已进行后处理,可以用于审核的结构化规则库。',
- 'description' => '用户通过 SubmitAuditNote 接口得到的 taskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。'."\n"
- .'在您使用本接口时,如果在入参中包含 taskId,能获取到您已通过 SubmitAuditNote 接口上传成功,但未通过 ConfirmAndProcessAuditNote 进行后处理的结构化规则库;而入参中不包含 taskId 时,则能获取到已进行后处理,可以用于审核的结构化规则库。',
+ 'title' => '风格 &quot;&lt;photography&gt;&quot;=摄影, &quot;&lt;portrait&gt;&quot;=人像写真, &quot;&lt;3d cartoon&gt;&quot;=3D卡通, &quot;&lt;anime&gt;&quot;=动画, &quot;&lt;oil painting&gt;&quot;=油画, &quot;&lt;watercolor&gt;&quot;=水彩, &quot;&lt;sketch&gt;&quot;=素描, &quot;&lt;chinese painting&gt;&quot;=中国画, &quot;&lt;flat illustration&gt;&quot;=扁平插画, &quot;&lt;auto&gt;&quot;=默认',
+ 'description' => '风格',
'type' => 'string',
- 'required' => false,
- 'example' => 'xxx_Default_1241541251241',
+ 'required' => true,
+ 'enumValueTitles' => ['<portrait>' => '人像写真', '<auto>' => '默认风格', '<3d cartoon>' => '3D卡通', 'watercolor' => '水彩', '<photography>' => '摄影', '<flat illustration>' => '扁平插画', '<sketch>' => '素描', '<oil painting>' => '油画', '<chinese painting>' => '中国画', '<anime>' => '动画'],
+ 'example' => '\'<auto>\'',
],
],
[
- 'name' => 'NoteId',
+ 'name' => 'Size',
'in' => 'formData',
'schema' => [
- 'title' => '规则库Id ,不填默认Default',
- 'description' => '规则库Id ,不填默认Default',
+ 'title' => '大小 1024*1024\', \'720*1280\', \'1280*720\'',
+ 'description' => '生成图片尺寸',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
+ 'enumValueTitles' => ['1024*1024' => '1024*1024', '720*1280' => '720*1280', '1280*720' => '1280*720'],
+ 'example' => '1024*1024',
],
],
+ [
+ 'name' => 'ArticleTaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文章taskId', 'description' => '文章taskId,如目前没有,可以赋值为UUID', 'type' => 'string', 'required' => true, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<GenerateImageTaskResponse>',
+ 'description' => 'PlainResult<GenerateImageTaskResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '目标规则库下载链接。',
- 'description' => '目标规则库下载链接。',
- 'type' => 'string',
- 'example' => 'http://download.xxx.yyy.zzz',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskList' => [
+ 'title' => '段落任务信息,根据输入的段落ID进行关联',
+ 'description' => '段落任务信息,根据输入的段落ID进行关联',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '段落对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '段落内容', 'description' => '段落内容', 'type' => 'string', 'example' => '一直忧伤的猫'],
+ 'Id' => ['title' => '段落ID', 'description' => '段落ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskId' => ['title' => '任务ID 任务唯一标识', 'description' => '任务ID 任务唯一标识', 'type' => 'string', 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'],
+ 'TaskStatus' => ['title' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中', 'description' => '当前任务状态 SUCCESSED=任务执行成功 ,FAILED=任务执行失败 ,CANCELED=任务被取消 ,PENDIN=任务排队中 ,SUSPENDE=任务挂起 RUNNIN=任务处理中', 'type' => 'string', 'example' => 'SUCCESSED'],
+ ],
+ ],
+ ],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成智能配图任务',
+ 'summary' => '根据文字异步生成图片。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"http://download.xxx.yyy.zzz\\"\\n}","type":"json"}]',
- 'title' => '下载规则库',
- ],
- 'DeleteAuditNote' => [
- 'summary' => '删除用户账户下所有可供审核使用的自定义规则库。删除后无法找回,如果您有对规则库存档的需求,请预先使用 DownloadAuditNote 接口保存需要的规则库。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateImageTask'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateImageTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskList\\": [\\n {\\n \\"Content\\": \\"一直忧伤的猫\\",\\n \\"Id\\": 1,\\n \\"TaskId\\": \\"e1be065b-adc3-435e-bd01-1c18c5ed75d3\\",\\n \\"TaskStatus\\": \\"SUCCESSED\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GenerateUploadConfig' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10641,99 +5879,132 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'FileName',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '文件名称', 'description' => '文件名称', 'type' => 'string', 'required' => false, 'example' => 'test.docx'],
],
[
- 'name' => 'NoteId',
+ 'name' => 'ParentDir',
'in' => 'formData',
'schema' => [
- 'title' => '规则库Id ,不填默认Default',
- 'description' => '规则库Id ,不填默认Default',
+ 'title' => '父目录 (materialDocument: 素材库, intervenes: 干预上传, temp: 临时上传目录, imageGenerate: 图像生成, datasetUpload: 数据集上传)',
+ 'description' => '父目录:'."\n"
+ .'- materialDocument: 妙笔-素材库'."\n"
+ .'- datasetUpload: 妙搜-数据集'."\n"
+ .'- intervenes:干预'."\n"
+ .'- temp: 临时上传目录(周期释放)',
'type' => 'string',
- 'required' => false,
+ 'required' => true,
+ 'example' => 'dataset',
+ 'enum' => ['materialDocument', 'intervenes', 'temp', 'imageGenerate', 'datasetUpload', 'deepWrite'],
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<UploadConfig>',
+ 'description' => 'PlainResult<UploadConfig>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '删除结果。如果删除成功,会返回“SUCCESSED”。',
- 'description' => '删除结果。如果删除成功,会返回“SUCCESSED”。',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileKey' => ['title' => '系统内唯一标识', 'description' => '文件唯一标识:可以当做url给到全妙', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
+ 'FormDatas' => [
+ 'title' => '表单提交数据',
+ 'description' => '上传oss的凭证信息:'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "OSSAccessKeyId": "xxx",'."\n"
+ .' "Signature": "xxx+xxx=",'."\n"
+ .' "MaxSize": 31457280,'."\n"
+ .' "key": "aimiaobi/dataset/2_2/xx.txt",'."\n"
+ .' "policy": "xxx=="'."\n"
+ .'}'."\n"
+ .'```',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'string', 'description' => ''],
+ ],
+ 'PostUrl' => ['title' => '如果这个为空则 postUrl 为上传服务的上传地址', 'description' => '上传oss的地址(妙笔自有的OSS域名,固定是:https://aimiaobi-service-prod.oss-cn-beijing.aliyuncs.com/)', 'type' => 'string', 'example' => 'https://aimiaobi-service-prod.oss-cn-beijing.aliyuncs.com/'],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成上传配置',
+ 'summary' => '生成文件上传配置。'."\n"
+ .'1. 使用本接口 获取上传的配置 返回 PostUrl (妙笔内部OSS地址)、以及OSS临时鉴权信息:key、OSSAccessKeyId、Signature、policy,还有文件唯一标识:fileKey'."\n"
+ .'2. 客户端 使用 PostUrl、以及临时鉴权信息:key、OSSAccessKeyId、Signature、policy 进行文件的上传'."\n"
+ .'3. 使用 fileKey 调用 后续带有fileKey的接口 (例如:GenerateFileUrlByKey)',
+ 'description' => '通过这接口可以拿到文件上传的地址和凭证,参考如下文档可以完成文件上传:'."\n"
+ .'[OSS-表单上传](https://help.aliyun.com/zh/oss/user-guide/form-upload?scm=20140722.H_31849._.OR_help-T_cn~zh-V_1)',
+ 'responseParamsDescription' => '## 执行文件上传'."\n"
+ .'拿到 PostUrl(妙笔官方OSS) 、FormDatas (OSS的临时鉴权)两个参数之后,需要手动上传 到OSS中。'."\n"
+ ."\n"
+ .'> 此步骤是核心上传步骤,一定要执行。'."\n"
+ .'> 执行上传完毕之后:fileKey即可用于其他接口。'."\n"
+ ."\n"
+ .'示例请求CURL为:'."\n"
+ .'> 注意:此示例仅为 简单的 CURL示例,具体SDK对接流程一般使用 **代码编写方式** 发起表单的文件上传。'."\n"
+ ."\n\n"
+ .'```shell'."\n"
+ .'curl -X POST --location "${PostUrl}" \\'."\n"
+ .' -H "Content-Type: multipart/form-data; boundary=WebKitFormBoundarykFF1FqdGZn2nxzfb" \\'."\n"
+ .' -F "key=${key};type=*/*" \\'."\n"
+ .' -F "OSSAccessKeyId=${OSSAccessKeyId};type=*/*" \\'."\n"
+ .' -F "Signature=${Signature};type=*/*" \\'."\n"
+ .' -F "policy=${policy};type=*/*" \\'."\n"
+ .' -F "file=@/Users/xxxx/xxx.text;filename=xxx.text;type=text/plain"'."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-10T09:49:11.000Z', 'description' => '请求参数发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-03-04T09:44:15.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"SUCCESSED\\"\\n}","type":"json"}]',
- 'title' => '删除规则库',
- ],
- 'GetAuditNotePostProcessingStatus' => [
- 'summary' => '查询规则库后处理的进度。与 ConfirmAndPostProcessAuditNote 接口配合使用,供您查询当前后处理任务的状态。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateUploadConfig'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateUploadConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FormDatas\\": {\\n \\"key\\": \\"\\"\\n },\\n \\"PostUrl\\": \\"https://aimiaobi-service-prod.oss-cn-beijing.aliyuncs.com/\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GenerateViewPoint' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10741,149 +6012,94 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ReferenceData',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。',
- 'description' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx_Default_12847192741412',
+ 'title' => '引用的上下文数据',
+ 'description' => '引用的上下文数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'MiniDoc' => [
+ 'title' => '传入的文章片段。',
+ 'description' => '传入的文章片段。',
+ 'type' => 'array',
+ 'items' => ['description' => '文章片段', 'type' => 'string', 'required' => false, 'example' => '文章片段'],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
],
],
],
'responses' => [
200 => [
'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',
- 'required' => true,
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'required' => true,
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
'Data' => [
- 'description' => '返回数据',
- 'type' => 'object',
- 'properties' => [
- 'NoteId' => [
- 'title' => '该规则库的 ID,现有版本默认为 "Default"。',
- 'description' => '该规则库的 ID,现有版本默认为 "Default"。',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'Status' => [
- 'title' => '本次后处理任务的状态。可选值:PENDING(待处理)、RUNNING(处理中)、SUCCESSED(成功)、FAILED(失败)',
- 'description' => '本次后处理任务的状态。可选值:PENDING(待处理)、RUNNING(处理中)、SUCCESSED(成功)、FAILED(失败)',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'TotalLines' => [
- 'title' => '结构化规则库的总行数。',
- 'description' => '结构化规则库的总行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '666',
- ],
- 'ProcessedLines' => [
- 'title' => '已后处理完成的行数。',
- 'description' => '已后处理完成的行数。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '233',
- ],
- 'ErrorMessage' => [
- 'title' => '错误消息,仅在后处理失败时会返回。',
- 'description' => '错误消息,仅在后处理失败时会返回。',
- 'type' => 'string',
- 'example' => 'error',
- ],
- 'CreateTime' => [
- 'title' => '本次后处理任务的创建时间(YYYY-MM-DD HH:mm:ss)。',
- 'description' => '本次后处理任务的创建时间(YYYY-MM-DD HH:mm:ss)。',
- 'type' => 'string',
- 'example' => '1970-01-01 12:34:56',
- ],
- 'CompletionTime' => [
- 'title' => '本次后处理任务的完成时间(YYYY-MM-DD HH:mm:ss)。',
- 'description' => '本次后处理任务的完成时间(YYYY-MM-DD HH:mm:ss)。',
- 'type' => 'string',
- 'example' => '1970-01-01 23:34:45',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '生成的视角',
+ 'type' => 'object',
+ 'properties' => [
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
],
],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成选题视角(已过时,不推荐使用)',
+ 'summary' => '生成选题视角。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"NoteId\\": \\"Default\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"TotalLines\\": 666,\\n \\"ProcessedLines\\": 233,\\n \\"ErrorMessage\\": \\"error\\",\\n \\"CreateTime\\": \\"1970-01-01 12:34:56\\",\\n \\"CompletionTime\\": \\"1970-01-01 23:34:45\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取规则库后处理进度',
- ],
- 'GetAuditNoteProcessingStatus' => [
- 'summary' => '查询用户上传规则库的处理状态。通过该接口,用户可以查询到当前规则库上传任务的状态,并获取到解析后的规则库文件大小、存储路径等信息。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateViewPoint'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateViewPoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Point\\": \\"视角\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetAuditNotePostProcessingStatus' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10891,35 +6107,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。',
- 'description' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx_Default_129873419274',
- ],
+ 'schema' => ['title' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。', 'description' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。', 'type' => 'string', 'required' => true, 'example' => 'xxx_Default_12847192741412'],
],
],
'responses' => [
@@ -10929,98 +6127,55 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'required' => true, 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'required' => true, 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'required' => true, 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'required' => true, 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'description' => '返回数据。',
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '任务处理状态(PENDING/RUNNING/SUCCESSED/FAILED)',
- 'description' => '任务处理状态(PENDING/RUNNING/SUCCESSED/FAILED)',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'UpdateTime' => [
- 'description' => '更新时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2024-11-25 11:40:50',
- ],
- 'TaskId' => [
- 'title' => '任务 ID,本次任务的唯一标识。',
- 'description' => '任务 ID,本次任务的唯一标识。',
- 'type' => 'string',
- 'example' => '111_Default_20250708142918',
- ],
- 'FileKey' => [
- 'title' => '后端业务存储本次规则库解析结果的路径。',
- 'description' => '后端业务存储本次规则库解析结果的路径。',
- 'type' => 'string',
- 'example' => 'oss://default/path/to/audit/note',
- ],
- 'FileSize' => [
- 'description' => '规则库文件大小。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '504',
- ],
- 'NoteName' => [
- 'title' => '解析之后的规则库名称。',
- 'description' => '解析之后的规则库名称。',
- 'type' => 'string',
- 'example' => '错题本2025-07-07_解析结果',
- ],
+ 'NoteId' => ['title' => '该规则库的 ID,现有版本默认为 "Default"。', 'description' => '该规则库的 ID,现有版本默认为 "Default"。', 'type' => 'string', 'example' => 'Default'],
+ 'Status' => ['title' => '本次后处理任务的状态。可选值:PENDING(待处理)、RUNNING(处理中)、SUCCESSED(成功)、FAILED(失败)', 'description' => '本次后处理任务的状态。可选值:PENDING(待处理)、RUNNING(处理中)、SUCCESSED(成功)、FAILED(失败)', 'type' => 'string', 'example' => 'RUNNING'],
+ 'TotalLines' => ['title' => '结构化规则库的总行数。', 'description' => '结构化规则库的总行数。', 'type' => 'integer', 'format' => 'int32', 'example' => '666'],
+ 'ProcessedLines' => ['title' => '已后处理完成的行数。', 'description' => '已后处理完成的行数。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '233'],
+ 'ErrorMessage' => ['title' => '错误消息,仅在后处理失败时会返回。', 'description' => '错误消息,仅在后处理失败时会返回。', 'type' => 'string', 'example' => 'error'],
+ 'CreateTime' => ['title' => '本次后处理任务的创建时间(YYYY-MM-DD HH:mm:ss)。', 'description' => '本次后处理任务的创建时间(YYYY-MM-DD HH:mm:ss)。', 'type' => 'string', 'example' => '1970-01-01 12:34:56'],
+ 'CompletionTime' => ['title' => '本次后处理任务的完成时间(YYYY-MM-DD HH:mm:ss)。', 'description' => '本次后处理任务的完成时间(YYYY-MM-DD HH:mm:ss)。', 'type' => 'string', 'example' => '1970-01-01 23:34:45'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取规则库后处理进度',
+ 'summary' => '查询规则库后处理的进度。与 ConfirmAndPostProcessAuditNote 接口配合使用,供您查询当前后处理任务的状态。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"UpdateTime\\": 0,\\n \\"TaskId\\": \\"111_Default_20250708142918\\",\\n \\"FileKey\\": \\"oss://default/path/to/audit/note\\",\\n \\"FileSize\\": 504,\\n \\"NoteName\\": \\"错题本2025-07-07_解析结果\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询规则库上传状态',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAuditNotePostProcessingStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"NoteId\\": \\"Default\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"TotalLines\\": 666,\\n \\"ProcessedLines\\": 233,\\n \\"ErrorMessage\\": \\"error\\",\\n \\"CreateTime\\": \\"1970-01-01 12:34:56\\",\\n \\"CompletionTime\\": \\"1970-01-01 23:34:45\\"\\n }\\n}","type":"json"}]',
],
- 'GetAvailableAuditNotes' => [
- 'summary' => '查询用户当前可供审核的规则库信息,只能查询到当前可用于审核的规则库。如果您想看到自定义规则库的具体内容,请使用 DownloadAuditNote 接口。',
+ 'GetAuditNoteProcessingStatus' => [
+ 'summary' => '查询用户上传规则库的处理状态。通过该接口,用户可以查询到当前规则库上传任务的状态,并获取到解析后的规则库文件大小、存储路径等信息。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11028,34 +6183,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'NoteId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '规则库Id ,不填默认Default',
- 'description' => '规则库Id ,不填默认Default',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。', 'description' => '用户通过 SubmitAuditNote 接口得到的 TaskId。这是自定义规则库任务索引的唯一标识,在使用时务必妥善保存。', 'type' => 'string', 'required' => true, 'example' => 'xxx_Default_129873419274'],
],
],
'responses' => [
@@ -11065,93 +6203,52 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'description' => '返回数据',
+ 'description' => '返回数据。',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '规则库存储主 ID。',
- 'description' => '规则库存储主 ID。',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'NoteId' => [
- 'title' => '规则库 ID。',
- 'description' => '规则库 ID。',
- 'type' => 'string',
- 'example' => 'Default',
- ],
- 'UpdateTime' => [
- 'title' => '规则库更新时间。',
- 'description' => '规则库更新时间。',
- 'type' => 'string',
- 'example' => '2025-07-07 11:56:30',
- ],
- 'FileSize' => [
- 'title' => '规则库文件大小(字节)',
- 'description' => '规则库文件大小(字节)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '23333',
- ],
- 'NoteName' => [
- 'title' => '解析之后的规则库名称。',
- 'description' => '解析之后的规则库名称。',
- 'type' => 'string',
- 'example' => '错题本2025-07-07_解析结果',
- ],
+ 'Status' => ['title' => '任务处理状态(PENDING/RUNNING/SUCCESSED/FAILED)', 'description' => '任务处理状态(PENDING/RUNNING/SUCCESSED/FAILED)', 'type' => 'string', 'example' => 'SUCCESSED'],
+ 'UpdateTime' => ['description' => '更新时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-11-25 11:40:50'],
+ 'TaskId' => ['title' => '任务 ID,本次任务的唯一标识。', 'description' => '任务 ID,本次任务的唯一标识。', 'type' => 'string', 'example' => '111_Default_20250708142918'],
+ 'FileKey' => ['title' => '后端业务存储本次规则库解析结果的路径。', 'description' => '后端业务存储本次规则库解析结果的路径。', 'type' => 'string', 'example' => 'oss://default/path/to/audit/note'],
+ 'FileSize' => ['description' => '规则库文件大小。', 'type' => 'integer', 'format' => 'int64', 'example' => '504'],
+ 'NoteName' => ['title' => '解析之后的规则库名称。', 'description' => '解析之后的规则库名称。', 'type' => 'string', 'example' => '错题本2025-07-07_解析结果'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询规则库上传状态',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"NoteId\\": \\"Default\\",\\n \\"UpdateTime\\": \\"2025-07-07 11:56:30\\",\\n \\"FileSize\\": 23333,\\n \\"NoteName\\": \\"错题本2025-07-07_解析结果\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询可用规则库',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAuditNoteProcessingStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"UpdateTime\\": 0,\\n \\"TaskId\\": \\"111_Default_20250708142918\\",\\n \\"FileKey\\": \\"oss://default/path/to/audit/note\\",\\n \\"FileSize\\": 504,\\n \\"NoteName\\": \\"错题本2025-07-07_解析结果\\"\\n }\\n}","type":"json"}]',
],
- 'ListAuditTerms' => [
- 'summary' => '获取词库列表。',
+ 'GetAutoClipsTaskInfo' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11159,56 +6256,27 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '任务唯一ID', 'type' => 'string', 'required' => true, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的Token',
- 'description' => '下一页的Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'XXXX',
- ],
+ 'schema' => ['description' => '[工作空间](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => '百炼工作空间Id'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'ShowResourceInfo',
'in' => 'formData',
- 'schema' => [
- 'description' => '返回的最大记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '展示视频素材信息', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'TermsName',
+ 'name' => 'ShowAnalysisResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '词典名称。可选。不填默认 Default',
- 'description' => '词典名称。可选。不填默认 Default',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['description' => '展示视频理解结果', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
@@ -11218,214 +6286,228 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'title' => '是否删除成功',
- 'description' => '是否删除成功',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '任务主键ID',
- 'description' => '任务主键ID',
- 'type' => 'string',
- 'example' => '1',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务唯一ID', 'type' => 'string', 'example' => 'e5a1a59c82d0454fad6454e8a04d0093'],
+ 'Step' => ['description' => '当前所处状态', 'type' => 'string', 'example' => 'clips'],
+ 'Status' => ['description' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消'],
+ 'Content' => ['description' => '全部口播内容', 'type' => 'string', 'example' => '口播内容'],
+ 'Timelines' => [
+ 'description' => '口播时间线数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '口播时间线',
+ 'type' => 'object',
+ 'properties' => [
+ 'TimelineId' => ['description' => '时间线id', 'type' => 'string', 'example' => '20774ebd9abc71ef80486632b68f0102'],
+ 'Content' => ['description' => '口播内容', 'type' => 'string', 'example' => '口播内容'],
+ 'Clips' => [
+ 'description' => '剪辑片段数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '剪辑片段',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClipId' => ['description' => '剪辑Id', 'type' => 'string', 'example' => '20774ebd9abc71ef80486632b68f0102'."\n"],
+ 'VideoName' => ['description' => '视频名字', 'type' => 'string', 'example' => '123.mp4'],
+ 'VideoId' => ['description' => '视频Id', 'type' => 'string', 'example' => '20774ebd9abc71ef80486632b68f0102'],
+ 'In' => ['description' => '片段开始时间(秒)已经废弃', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Out' => ['description' => '片段结束时间(秒)已经废弃', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'ContentInner' => ['description' => '口播分段内容', 'type' => 'string', 'example' => '口播分段内容'],
+ 'InEx' => ['description' => '片段开始时间(毫秒)', 'type' => 'number', 'format' => 'float', 'example' => '0.33'],
+ 'OutEx' => ['description' => '片段结束时间 (毫秒)', 'type' => 'number', 'format' => 'float', 'example' => '3.45'],
+ ],
+ ],
+ ],
+ ],
],
- 'Keyword' => [
- 'title' => '关键词',
- 'description' => '关键词',
- 'type' => 'string',
- 'example' => '龘',
+ ],
+ 'VoiceStyle' => ['description' => '口播声音类型', 'type' => 'string', 'example' => '温柔女声'],
+ 'MusicStyle' => ['description' => '推荐音乐类型', 'type' => 'string', 'example' => '国风'],
+ 'MusicUrl' => ['description' => '背景音乐地址', 'type' => 'string', 'example' => 'http://music.mp4'],
+ 'MusicVolume' => ['description' => '音乐音量', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'VoiceVolume' => ['description' => '口播音量', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'SubtitleFontSize' => ['description' => '字幕大小', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'OutputVideoUrl' => ['description' => '成片地址', 'type' => 'string', 'example' => 'http://output.mp4'],
+ 'MediaCloudTimeline' => ['description' => '视频云timeline', 'type' => 'string', 'example' => '视频云格式timeline'],
+ 'ColorWords' => [
+ 'description' => '花字信息数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '花字信息元素',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '花字内容', 'type' => 'string', 'example' => '花字内容'],
+ 'TimelineIn' => ['description' => '花字开始时间(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TimelineOut' => ['description' => '花字结束时间(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'X' => ['description' => '花字位置横坐标', 'type' => 'number', 'format' => 'float', 'example' => '0.2'],
+ 'Y' => ['description' => '花字位置纵坐标', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
+ 'FontSize' => ['description' => '花字大小', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'EffectColorStyle' => ['description' => '花字效果', 'type' => 'string', 'example' => 'CS0002-000008'],
+ ],
+ ],
+ ],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'CloseVoice' => ['title' => '关闭口播', 'description' => '关闭口播', 'type' => 'boolean'],
+ 'CloseSubtitle' => ['title' => '关闭字幕', 'description' => '关闭字幕', 'type' => 'boolean'],
+ 'CloseMusic' => ['title' => '关闭音乐', 'description' => '关闭音乐', 'type' => 'boolean'],
+ 'CustomVoiceUrl' => ['title' => '自定义声道文件地址', 'description' => '自定义声道文件地址', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'],
+ 'CustomVoiceVolume' => ['title' => '自定义声道音量', 'description' => '自定义声道音量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Stickers' => [
+ 'title' => '贴纸数组',
+ 'description' => '贴纸数组',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '贴纸结构',
+ 'description' => '贴纸结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => '贴纸gif文件地址', 'description' => '贴纸gif文件地址', 'type' => 'string', 'example' => 'http://xxx/xxx.gif'],
+ 'TimelineIn' => ['title' => '贴纸开始时间(秒)', 'description' => '贴纸开始时间(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Duration' => ['title' => '贴纸出现时长', 'description' => '贴纸出现时长', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'X' => ['title' => '贴纸出现位置横坐标', 'description' => '贴纸出现位置横坐标', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'Y' => ['title' => '贴纸出现位置纵坐标', 'description' => '贴纸出现位置纵坐标', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ 'Width' => ['title' => '贴纸宽度', 'description' => '贴纸宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Height' => ['title' => '贴纸高度', 'description' => '贴纸高度', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'DyncFrames' => ['title' => '贴纸高度', 'description' => '贴纸高度', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ ],
],
- 'SuggestWord' => [
- 'title' => '建议词',
- 'description' => '建议词',
- 'type' => 'string',
- 'example' => '龘(dá)',
+ ],
+ 'CustomVoiceStyle' => ['description' => 'cosyvoice的音色', 'type' => 'string', 'example' => 'longxian_normal'],
+ 'OutputVideoFileKey' => ['description' => '输出结果fileKey', 'type' => 'string', 'example' => 'oss://xxx/xxx.mp4'],
+ 'OpeningCreditsUrl' => ['description' => '片头视频地址', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'],
+ 'ClosingCreditsUrl' => ['description' => '片尾视频地址', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'],
+ 'SourceVideos' => [
+ 'description' => '剪辑素材结构列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '剪辑素材结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'VideoId' => ['description' => '视频ID', 'type' => 'string', 'example' => 'fdaswe'],
+ 'VideoName' => ['description' => '视频名称', 'type' => 'string', 'example' => 'video001.mp4'],
+ 'VideoUrl' => ['description' => '视频地址。', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'],
+ ],
],
- 'TermsDesc' => [
- 'title' => '审核依据',
- 'description' => '审核依据',
- 'type' => 'string',
- 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。',
+ ],
+ 'ReferenceVideo' => [
+ 'description' => '参考视频信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'VideoId' => ['description' => '视频ID', 'type' => 'string', 'example' => '90ca686b11c371f08339752281ed0102'],
+ 'VideoName' => ['description' => '视频名称', 'type' => 'string', 'example' => 'video001.mp4'],
+ 'VideoUrl' => ['description' => '视频URL', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'],
],
- 'ExceptionWord' => [
- 'title' => '例外语句',
- 'description' => '例外语句',
- 'type' => 'array',
- 'items' => [
- 'title' => '词典名称',
- 'description' => '词典名称',
- 'type' => 'string',
+ ],
+ 'AnalysisResults' => [
+ 'description' => '视频理解结果列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '视频理解结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'MediaId' => ['description' => '视频Id', 'type' => 'string', 'example' => '975e1d91a8d057e132cc5d88e4d5b360'],
+ 'MediaName' => ['description' => '视频名字', 'type' => 'string', 'example' => 'video001.mp4'],
+ 'MediaUrl' => ['description' => '视频地址', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'],
+ 'LensInfos' => [
+ 'description' => '镜头信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '镜头信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => [
+ 'description' => '开始时间',
+ 'type' => 'object',
+ 'properties' => [
+ 'Hour' => ['description' => '小时', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Minute' => ['description' => '分钟', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Second' => ['description' => '秒', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'MillSecond' => ['description' => '毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ ],
+ 'EndTime' => [
+ 'description' => '结束时间',
+ 'type' => 'object',
+ 'properties' => [
+ 'Hour' => ['description' => '时', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'Minute' => ['description' => '分', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Second' => ['description' => '秒', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'MillSecond' => ['description' => '毫秒', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ ],
+ 'AnalysisContent' => ['description' => '理解内容', 'type' => 'string', 'example' => '视频理解内容'],
+ ],
+ ],
+ ],
],
],
- 'TermsName' => [
- 'title' => '词典名称',
- 'description' => '词典名称',
- 'type' => 'string',
- ],
],
],
],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '77',
- ],
- 'NextToken' => [
- 'title' => '下一页的Token',
- 'description' => '下一页的Token',
- 'type' => 'string',
- 'example' => 'x\'x\'x',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '58',
- ],
+ 'HttpStatusCode' => ['title' => '', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Keyword\\": \\"龘\\",\\n \\"SuggestWord\\": \\"龘(dá)\\",\\n \\"TermsDesc\\": \\"龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。\\",\\n \\"ExceptionWord\\": [\\n \\"\\"\\n ],\\n \\"TermsName\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 77,\\n \\"NextToken\\": \\"x\'x\'x\\",\\n \\"TotalCount\\": 58\\n}","type":"json"}]',
- 'title' => '获取自定义词库记录',
- ],
- 'AddAuditTerms' => [
- 'summary' => '添加审核自定义词库记录。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得剪辑任务信息',
+ 'summary' => '获得剪辑任务状态',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAutoClipsTaskInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"e5a1a59c82d0454fad6454e8a04d0093\\",\\n \\"Step\\": \\"clips\\",\\n \\"Status\\": 0,\\n \\"Content\\": \\"口播内容\\",\\n \\"Timelines\\": [\\n {\\n \\"TimelineId\\": \\"20774ebd9abc71ef80486632b68f0102\\",\\n \\"Content\\": \\"口播内容\\",\\n \\"Clips\\": [\\n {\\n \\"ClipId\\": \\"20774ebd9abc71ef80486632b68f0102\\\\n\\",\\n \\"VideoName\\": \\"123.mp4\\",\\n \\"VideoId\\": \\"20774ebd9abc71ef80486632b68f0102\\",\\n \\"In\\": 0,\\n \\"Out\\": 5,\\n \\"ContentInner\\": \\"口播分段内容\\",\\n \\"InEx\\": 0.33,\\n \\"OutEx\\": 3.45\\n }\\n ]\\n }\\n ],\\n \\"VoiceStyle\\": \\"温柔女声\\",\\n \\"MusicStyle\\": \\"国风\\",\\n \\"MusicUrl\\": \\"http://music.mp4\\",\\n \\"MusicVolume\\": 5,\\n \\"VoiceVolume\\": 5,\\n \\"SubtitleFontSize\\": 5,\\n \\"OutputVideoUrl\\": \\"http://output.mp4\\",\\n \\"MediaCloudTimeline\\": \\"视频云格式timeline\\",\\n \\"ColorWords\\": [\\n {\\n \\"Content\\": \\"花字内容\\",\\n \\"TimelineIn\\": 0,\\n \\"TimelineOut\\": 5,\\n \\"X\\": 0.2,\\n \\"Y\\": 0.5,\\n \\"FontSize\\": 5,\\n \\"EffectColorStyle\\": \\"CS0002-000008\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"CloseVoice\\": true,\\n \\"CloseSubtitle\\": true,\\n \\"CloseMusic\\": true,\\n \\"CustomVoiceUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"CustomVoiceVolume\\": 0,\\n \\"Stickers\\": [\\n {\\n \\"Url\\": \\"http://xxx/xxx.gif\\",\\n \\"TimelineIn\\": 10,\\n \\"Duration\\": 10,\\n \\"X\\": 100,\\n \\"Y\\": 100,\\n \\"Width\\": 200,\\n \\"Height\\": 200,\\n \\"DyncFrames\\": 8\\n }\\n ],\\n \\"CustomVoiceStyle\\": \\"longxian_normal\\",\\n \\"OutputVideoFileKey\\": \\"oss://xxx/xxx.mp4\\",\\n \\"OpeningCreditsUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"ClosingCreditsUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"SourceVideos\\": [\\n {\\n \\"VideoId\\": \\"fdaswe\\",\\n \\"VideoName\\": \\"video001.mp4\\",\\n \\"VideoUrl\\": \\"http://xxx/xxx.mp4\\"\\n }\\n ],\\n \\"ReferenceVideo\\": {\\n \\"VideoId\\": \\"90ca686b11c371f08339752281ed0102\\",\\n \\"VideoName\\": \\"video001.mp4\\",\\n \\"VideoUrl\\": \\"http://xxx/xxx.mp4\\"\\n },\\n \\"AnalysisResults\\": [\\n {\\n \\"MediaId\\": \\"975e1d91a8d057e132cc5d88e4d5b360\\",\\n \\"MediaName\\": \\"video001.mp4\\",\\n \\"MediaUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"LensInfos\\": [\\n {\\n \\"StartTime\\": {\\n \\"Hour\\": 2,\\n \\"Minute\\": 1,\\n \\"Second\\": 30,\\n \\"MillSecond\\": 100\\n },\\n \\"EndTime\\": {\\n \\"Hour\\": 2,\\n \\"Minute\\": 1,\\n \\"Second\\": 30,\\n \\"MillSecond\\": 100\\n },\\n \\"AnalysisContent\\": \\"视频理解内容\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetAvailableAuditNotes' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'Keyword',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '关键词',
- 'description' => '关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '龘',
- ],
- ],
- [
- 'name' => 'SuggestWord',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '建议词',
- 'description' => '建议词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '龘(dá)',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'TermsDesc',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '审核依据',
- 'description' => '审核依据',
- 'type' => 'string',
- 'required' => false,
- 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。',
- ],
- ],
- [
- 'name' => 'ExceptionWord',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '例外语句',
- 'description' => '例外语句',
- 'type' => 'array',
- 'items' => [
- 'title' => '例外语句',
- 'description' => '例外语句',
- 'type' => 'string',
- 'required' => false,
- 'example' => '例外语句',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'TermsName',
+ 'name' => 'NoteId',
'in' => 'formData',
- 'schema' => [
- 'title' => '词典名称。可选。不填默认 Default',
- 'description' => '词典名称。可选。不填默认 Default',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default',
- ],
+ 'schema' => ['title' => '规则库Id ,不填默认Default', 'description' => '规则库Id ,不填默认Default', 'type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -11435,162 +6517,72 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据(更新是否成功-已弃用-推荐使用 DataV1 拿到主键ID)',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DataV1' => [
- 'title' => '业务数据'."\n"
- .'根数据版本1',
- 'description' => '返回词库单词ID',
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => 'ID',
- 'description' => 'ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '562fe4163a59d7bcb44bfdde4e3d5046',
- ],
+ 'Id' => ['title' => '规则库存储主 ID。', 'description' => '规则库存储主 ID。', 'type' => 'string', 'example' => '1'],
+ 'NoteId' => ['title' => '规则库 ID。', 'description' => '规则库 ID。', 'type' => 'string', 'example' => 'Default'],
+ 'UpdateTime' => ['title' => '规则库更新时间。', 'description' => '规则库更新时间。', 'type' => 'string', 'example' => '2025-07-07 11:56:30'],
+ 'FileSize' => ['title' => '规则库文件大小(字节)', 'description' => '规则库文件大小(字节)', 'type' => 'integer', 'format' => 'int64', 'example' => '23333'],
+ 'NoteName' => ['title' => '解析之后的规则库名称。', 'description' => '解析之后的规则库名称。', 'type' => 'string', 'example' => '错题本2025-07-07_解析结果'],
],
- 'example' => '返回添加的实体信息',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询可用规则库',
+ 'summary' => '查询用户当前可供审核的规则库信息,只能查询到当前可用于审核的规则库。如果您想看到自定义规则库的具体内容,请使用 DownloadAuditNote 接口。',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"DataV1\\": {\\n \\"Id\\": 0\\n }\\n}","type":"json"}]',
- 'title' => '添加自定义词库记录',
- ],
- 'EditAuditTerms' => [
- 'summary' => '编辑审核自定义词库记录',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAvailableAuditNotes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Id\\": \\"1\\",\\n \\"NoteId\\": \\"Default\\",\\n \\"UpdateTime\\": \\"2025-07-07 11:56:30\\",\\n \\"FileSize\\": 23333,\\n \\"NoteName\\": \\"错题本2025-07-07_解析结果\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetBiddingDocInfo' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'Keyword',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '关键词',
- 'description' => '关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '龘',
- ],
- ],
- [
- 'name' => 'SuggestWord',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '建议词',
- 'description' => '建议词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '龘(dá)',
- ],
- ],
- [
- 'name' => 'TermsDesc',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '审核依据',
- 'description' => '审核依据',
- 'type' => 'string',
- 'required' => false,
- 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。',
- ],
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20103',
- ],
- ],
- [
- 'name' => 'ExceptionWord',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '例外语句',
- 'description' => '例外语句',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'],
],
],
'responses' => [
@@ -11600,62 +6592,64 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Step' => ['description' => '当前所处状态', 'type' => 'string', 'example' => 'analysis'."\n"
+ .'writing'],
+ 'Status' => ['description' => '任务状态', 'type' => 'integer', 'format' => 'int32', 'example' => '0-waiting、1-running、2-success、3-pause、4-fail'."\n"],
+ 'Content' => ['description' => '标书内容', 'type' => 'string', 'example' => '文章内容'],
+ 'ContentType' => ['description' => '文件类型。', 'type' => 'string', 'example' => 'outline'."\n"
+ .'bidding'],
+ 'ContentFormat' => ['description' => '格式', 'type' => 'string', 'example' => 'markdown'."\n"
+ .'html'],
+ 'TenderDocUrl' => ['description' => '招标书地址', 'type' => 'string', 'example' => 'http://xxx'],
+ 'TenderFileType' => ['description' => '招标书文件类型', 'type' => 'string', 'example' => 'pdf'."\n"
+ .'docx'],
+ ],
],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '编辑自定义词库记录',
- ],
- 'DeleteAuditTerms' => [
- 'summary' => '删除指定的词库记录。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得标书写作结果',
+ 'summary' => '获得标书写作结果接口',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetBiddingDocInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Step\\": \\"analysis\\\\nwriting\\",\\n \\"Status\\": 0,\\n \\"Content\\": \\"文章内容\\",\\n \\"ContentType\\": \\"outline\\\\nbidding\\",\\n \\"ContentFormat\\": \\"markdown\\\\nhtml\\",\\n \\"TenderDocUrl\\": \\"http://xxx\\",\\n \\"TenderFileType\\": \\"pdf\\\\ndocx\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
+ ],
+ 'GetBiddingRemainLimitNum' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11663,43 +6657,17 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'IdList',
+ 'name' => 'ApiName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '指定要删除的用户登录的规则id列表。',
- 'description' => '指定要删除的用户登录的规则id列表。',
- 'type' => 'array',
- 'items' => [
- 'title' => '指定要删除的用户登录的规则id列表。',
- 'description' => '指定要删除的用户登录的规则id列表。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '4463',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => 'api名称', 'type' => 'string', 'required' => false, 'example' => 'asyncUploadTenderDoc'],
],
],
'responses' => [
@@ -11709,158 +6677,107 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误消息', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'RemainNum' => ['description' => '剩余数量', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '删除指定词库记录',
- ],
- 'SubmitImportTermsTask' => [
- 'summary' => '提交导入自定义词库任务',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得标书写作剩余额度',
+ 'summary' => '获得标书功能剩余额度',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetBiddingRemainLimitNum',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RemainNum\\": 1\\n }\\n}","type":"json"}]',
+ ],
+ 'GetCategoriesByTaskId' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'FileKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文件FileKey',
- 'description' => '文件FileKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TermsName',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '词典名称。可选。不填默认 Default',
- 'description' => '词典名称。可选。不填默认 Default',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
],
],
'responses' => [
200 => [
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- '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' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'description' => '分类对象列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '分类对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['description' => '分类名称', 'type' => 'string', 'example' => '类别1'],
+ 'Children' => [
+ 'description' => '子分类列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子分类对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['description' => '子分类名称', 'type' => 'string', 'example' => '类别1-1'],
+ ],
+ ],
+ ],
+ 'Count' => ['title' => '该分类下对应的VOC数量', 'description' => '该分类下对应的VOC数量', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
],
],
@@ -11868,22 +6785,32 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '根据任务ID获取分类列表',
+ 'summary' => '获取某次标签挖掘结果分类。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
- 'title' => '提交导入词库任务',
- 'requestParamsDescription' => '<notice>FileKey 生成方式见 [通用接口-文件上传下载GenerateUploadConfig - 生成上传配置](https://help.aliyun.com/zh/model-studio/api-aimiaobi-2023-08-01-generateuploadconfig)</notice>',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCategoriesByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Category\\": \\"类别1\\",\\n \\"Children\\": [\\n {\\n \\"Category\\": \\"类别1-1\\"\\n }\\n ],\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]',
],
- 'FetchImportTermsTask' => [
- 'summary' => '获取导入词库任务结果',
+ 'GetClipsBuildInResource' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -11891,35 +6818,18 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '百炼业务空间Id', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ResourceType',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件FileKey',
- 'description' => '文件FileKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
+ 'schema' => ['description' => '资源类型。', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0 - 音色'."\n"
+ .'1- 背景音'],
],
],
'responses' => [
@@ -11929,176 +6839,147 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- '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' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '错误码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '任务执行状态',
- 'description' => '任务执行状态',
- 'type' => 'string',
- 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
+ 'ResourceType' => ['description' => '资源类型。', 'type' => 'integer', 'format' => 'int32', 'example' => '0 - 音色'."\n"
+ .'1- 背景音'],
+ 'ResourceList' => [
+ 'description' => '资源列表',
+ 'type' => 'array',
+ 'items' => ['description' => '资源列表', 'type' => 'string', 'example' => '轻快'],
],
],
],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '返回结果消息', 'type' => 'string', 'example' => 'successful'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Status\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取导入词库任务结果',
- ],
- 'SubmitExportTermsTask' => [
- 'summary' => '导出词库任务',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取智能混剪内置资源',
+ 'summary' => '获得智能混剪内置资源',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetClipsBuildInResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"ResourceType\\": 0,\\n \\"ResourceList\\": [\\n \\"轻快\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetCustomHotTopicBroadcastJob' => [
+ 'summary' => '获取自定义播报单任务结果。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TermsName',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '词典名称。可选。不填默认 Default',
- 'description' => '词典名称。可选。不填默认 Default',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => '2e27abb32cb64f80a0c6e829b6c87a09'],
],
],
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'HotTopicVersion' => ['title' => '热点话题版本号标识', 'description' => '热点话题版本号标识', 'type' => 'string', 'example' => '热点话题版本号标识'],
+ 'Status' => [
+ 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'description' => '任务状态 '."\n"
+ ."\n"
+ .'- PENDING:待执行'."\n"
+ .'- RUNNING:执行中'."\n"
+ .'- SUCCESSED:成功'."\n"
+ .'- SUSPENDED:暂停'."\n"
+ .'- FAILED:失败'."\n"
+ .'- CANCELED:取消',
'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'example' => 'RUNNING',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
],
],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
- 'title' => ' 提交导出词库任务',
- ],
- 'FetchExportTermsTask' => [
- 'summary' => '获取词库导出任务结果',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义播报单任务结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomHotTopicBroadcastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"HotTopicVersion\\": \\"热点话题版本号标识\\",\\n \\"Status\\": \\"RUNNING\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetCustomSourceTopicAnalysisTask' => [
+ 'summary' => '获取自定义数据源-选题视角分析任务结果',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -12106,412 +6987,450 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件FileKey',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'required' => true, 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2'],
],
],
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'FileUrl' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'https//xxxx',
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Status' => ['title' => '任务状态', 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', 'type' => 'string', 'example' => 'SUCCESSED'],
+ 'ParsedNewsSize' => ['title' => '解析后的新闻数量', 'description' => '解析文件后的新闻数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'ClusterCount' => ['title' => '聚类后的文档数量', 'description' => '聚类后的文档数量', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'MaxClusteredTopicNewsSize' => ['description' => '聚合后的最大新闻数量', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'ClusterResults' => [
+ 'title' => '新闻聚合结果列表',
+ 'description' => '新闻聚合结果列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '聚合结果对象',
+ 'description' => '聚合结果对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClusterNews' => [
+ 'title' => '聚合新闻列表(不包含正文)',
+ 'description' => '聚合新闻列表(不包含正文)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '新闻对象',
+ 'description' => '新闻对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['title' => '新闻标题', 'description' => '新闻标题', 'type' => 'string', 'example' => '新闻标题'."\n"
+ ."\n"],
+ 'Url' => ['title' => '新闻Url', 'description' => '新闻Url', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'],
+ ],
+ ],
+ ],
+ 'Topic' => ['title' => '聚合话题名称', 'description' => '聚合话题名称', 'type' => 'string', 'example' => '话题名称'],
+ ],
+ ],
],
- 'Status' => [
- 'title' => '任务执行状态',
- 'description' => '任务执行状态',
- 'type' => 'string',
- 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
+ 'usages' => [
+ 'title' => 'token使用情况。可能使用到的付费项为:'."\n"
+ .'quanmiaoMax、quanmiaoPlus',
+ 'description' => 'token使用情况。可能使用到的付费项为:'."\n"
+ .'quanmiaoMax、quanmiaoPlus',
+ 'type' => 'object',
+ 'additionalProperties' => ['title' => 'token使用数量', 'description' => 'token使用数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
+ 'rt' => ['title' => '总运行时长,单位毫秒', 'description' => '总运行时长,单位毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
],
],
+ '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'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"FileUrl\\": \\"https//xxxx\\",\\n \\"Status\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取导出词库任务结果',
- ],
- 'SubmitFactAuditUrl' => [
- 'summary' => '妙笔为您提供了新的事实性审核能力,在联网搜索并判断正误的前提下,还支持用户自定义配置搜索来源 URL。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义源话题分析任务结果',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-26T12:18:54.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomSourceTopicAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ParsedNewsSize\\": 10,\\n \\"ClusterCount\\": 5,\\n \\"MaxClusteredTopicNewsSize\\": 8,\\n \\"ClusterResults\\": [\\n {\\n \\"ClusterNews\\": [\\n {\\n \\"Title\\": \\"新闻标题\\\\n\\\\n\\",\\n \\"Url\\": \\"http://www.example.com/xxx.html\\"\\n }\\n ],\\n \\"Topic\\": \\"话题名称\\"\\n }\\n ],\\n \\"usages\\": {\\n \\"key\\": 200\\n },\\n \\"rt\\": 1000\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'GetCustomText' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '63'],
],
[
- 'name' => 'Url',
+ 'name' => 'CommodityCode',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户希望使用的审核信息来源 URL。通过该接口新增信源 URL 后,事实性审核的信息来源会只从配置好的 URL 列表中获取;如果不新增 URL,则默认从全网检索审核所需的信息。每位用户最多可以配置 10 条信源 URL。',
- 'description' => '用户希望使用的审核信息来源 URL。通过该接口新增信源 URL 后,事实性审核的信息来源会只从配置好的 URL 列表中获取;如果不新增 URL,则默认从全网检索审核所需的信息。每位用户最多可以配置 10 条信源 URL。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://aliyun.com',
- ],
+ 'schema' => ['title' => '商品code', 'description' => '商品code', 'type' => 'string', 'required' => false, 'example' => '商品code'],
],
],
'responses' => [
200 => [
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '新增 URL 的成功提示。',
- 'description' => '新增 URL 的成功提示。',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '内容'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '创建时间'],
+ 'CreateUser' => ['title' => '创建用户', 'description' => '创建用户', 'type' => 'string', 'example' => '创建用户'],
+ 'Id' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '修改时间'],
+ 'UpdateUser' => ['title' => '修改用户', 'description' => '修改用户', 'type' => 'string', 'example' => '修改用户'],
+ ],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义文本',
+ 'summary' => '获取自定义文本。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"SUCCESSED\\"\\n}","type":"json"}]',
- 'title' => '提交事实性审核 URL',
- ],
- 'GetFactAuditUrl' => [
- 'summary' => '获取当前正用于事实性审核的信源 URL。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Content\\": \\"内容\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CreateUser\\": \\"创建用户\\",\\n \\"Id\\": 34,\\n \\"Title\\": \\"标题\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"UpdateUser\\": \\"修改用户\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetCustomTopicSelectionPerspectiveAnalysisTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba'],
],
],
'responses' => [
200 => [
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '当前正用于事实性审核的信源 URL 列表。当列表中没有 URL 时,检索信源为全网;有 URL 时,只从配置好的 URL 中获取信息。删除不需要的信源 URL 时,请使用出参中的 URL 填写到 DeleteFactAuditUrl 接口的入参。',
- 'description' => '当前正用于事实性审核的信源 URL 列表。当列表中没有 URL 时,检索信源为全网;有 URL 时,只从配置好的 URL 中获取信息。删除不需要的信源 URL 时,请使用出参中的 URL 填写到 DeleteFactAuditUrl 接口的入参。',
- 'type' => 'array',
- 'items' => [
- 'description' => '返回的数据内容。',
- 'type' => 'string',
- 'example' => 'aliyun.com',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'CustomViewPointsResult' => [
+ 'title' => '自定义选题分析任务结果',
+ 'description' => '自定义选题分析任务结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitudes' => [
+ 'title' => '自定义观点列表。默认会根据Prompt输入生成一个观点',
+ 'description' => '自定义观点列表。默认会根据Prompt输入生成一个观点',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Topic' => ['title' => '热点主题事件', 'description' => '热点主题事件', 'type' => 'string', 'example' => '热点主题事件'],
+ ],
+ ],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Status' => [
+ 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'description' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'type' => 'string',
+ 'example' => 'FAILED',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
+ ],
],
- 'required' => true,
- 'maxItems' => 10,
- 'minItems' => 0,
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"aliyun.com\\"\\n ]\\n}","type":"json"}]',
- 'title' => '获取事实性审核 URL',
- ],
- 'DeleteFactAuditUrl' => [
- 'summary' => '删除指定的用于事实性审核的 URL。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义选题视角分析任务结果',
+ 'summary' => '获取自定义选题视角分析任务结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"CustomViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"Topic\\": \\"热点主题事件\\"\\n },\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Status\\": \\"FAILED\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetDataSourceOrderConfig' => [
+ 'summary' => '获取写作信源,通用搜索信源的配置信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'd9a1f6146a37446495d9985c2e7b267e_p_outbound_public'],
+ ],
+ [
+ 'name' => 'ProductCode',
'in' => 'formData',
'schema' => [
- 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
+ 'title' => '配置类型 可选值 miaobi、miaosou',
+ 'description' => '配置类型。可选值如下:'."\n"
+ ."\n"
+ .'- miaobi'."\n"
+ ."\n"
+ .'- miaosou',
'type' => 'string',
'required' => true,
- 'example' => 'llm-xx',
+ 'example' => 'miaobi',
+ 'enum' => ['miaobi', 'miaosou'],
],
],
[
- 'name' => 'Url',
+ 'name' => 'GenerateTechnology',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户希望删除的审核信息来源 URL,填写的 URL 需要和通过GetFactAuditUrl 得到的结果一致才能顺利删除。',
- 'description' => '用户希望删除的审核信息来源 URL,填写的 URL 需要和通过GetFactAuditUrl 得到的结果一致才能顺利删除。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://aliyun.com',
- ],
+ 'schema' => ['title' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
+ .'取值:"copilotPrecise","copilotReference"', 'description' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
+ ."\n"
+ .'可取值如下:'."\n"
+ ."\n"
+ .'- copilotPrecise'."\n"
+ ."\n"
+ .'- copilotReference', 'type' => 'string', 'required' => false, 'example' => 'copilotPrecise'],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<GetDataSourceOrderConfigResponse>',
+ 'description' => 'PlainResult<GetDataSourceOrderConfigResponse>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '删除 URL 的成功提示。',
- 'description' => '删除 URL 的成功提示。',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'UserConfigDataSourceList' => [
+ 'title' => '用户配置数据源权重列表',
+ 'description' => '用户配置数据源权重列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => 'code描述', 'description' => 'code描述', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'Name' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'example' => '夸克通用搜索'],
+ 'Number' => ['title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'Type' => ['title' => 'type类型', 'description' => 'type类型', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'Enable' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'TotalDocSize' => ['title' => '最大文档总数', 'description' => '最大文档总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取信源配置权重数据',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-08T10:52:59.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-07T08:34:56.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-07T06:29:23.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"SUCCESSED\\"\\n}","type":"json"}]',
- 'title' => '删除事实性审核 URL',
- ],
- 'QueryAuditTask' => [
- 'summary' => '查询审核结果。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDataSourceOrderConfig'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDataSourceOrderConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"UserConfigDataSourceList\\": [\\n {\\n \\"Code\\": \\"QuarkCommonNews\\",\\n \\"Name\\": \\"夸克通用搜索\\",\\n \\"Number\\": 20,\\n \\"Type\\": \\"SystemSearch\\",\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalDocSize\\": 1\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetDataset' => [
+ 'summary' => '数据源管理-详情。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -12519,424 +7438,399 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ContentAuditTaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '审核任务ID(任务ID与文章ID二选一)',
- 'description' => '审核任务ID(任务ID与文章ID二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'ArticleId',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'schema' => [
- 'title' => '文章ID(任务ID与文章ID二选一)',
- 'description' => '文章ID(任务ID与文章ID二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '数据集名称,全局唯一', 'description' => '数据集名称,全局唯一', 'type' => 'string', 'required' => false, 'example' => 'businessDataset', 'maxLength' => 30, 'minLength' => 3],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxxx',
- ],
+ 'schema' => ['title' => '数据集id', 'description' => '数据集id:和DatasetName二选一必选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
'Data' => [
- 'description' => '异步任务对象',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskStatus' => [
- 'title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败,6-任务取消',
- 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败,6-任务取消',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Content' => [
- 'title' => '审核时的原文',
- 'description' => '审核时的原文',
- 'type' => 'string',
- 'example' => '审核时的原文',
- ],
- 'AuditTime' => [
- 'title' => '审核时间',
- 'description' => '审核时间',
- 'type' => 'string',
- 'example' => '2025-05-13 12:12:12',
- ],
- 'Response' => [
- 'title' => '审核结果',
- 'description' => '审核结果',
+ 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-12 21:46:24'],
+ 'DatasetType' => ['title' => '数据集类型', 'description' => '数据集类型', 'type' => 'string', 'example' => 'CustomSemanticSearch'],
+ 'DatasetName' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'example' => 'xxx'],
+ 'DatasetConfig' => [
+ 'description' => '数据集搜索配置',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '审核响应头',
- 'description' => '审核响应头',
- 'type' => 'object',
- 'properties' => [
- 'Event' => [
- 'title' => '事件',
- 'description' => '事件',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'SessionId' => [
- 'title' => '对话唯一标识',
- 'description' => '对话唯一标识',
- 'type' => 'string',
- 'example' => '49eab783-9172-487a-b9df-c6372c47392c',
- ],
- 'TaskId' => [
- 'title' => '多轮对话唯一标识',
- 'description' => '多轮对话唯一标识',
- 'type' => 'string',
- 'example' => '896b733535274d28b1a61c78bc145217',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '最终响应结果(json数组结构)',
- 'description' => '最终响应结果(json数组结构)',
- 'type' => 'string',
- 'example' => 'x\'x\'x',
+ 'SearchSourceConfigs' => [
+ 'title' => '三方搜索:api定义',
+ 'description' => '三方搜索:api定义',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '三方搜索:api定义',
+ 'type' => 'object',
+ 'properties' => [
+ 'DemoQuery' => ['title' => '可以搜索到的关键词,用来验证是否可用', 'description' => '可以搜索到的关键词,用来验证是否可用', 'type' => 'string', 'example' => '可以搜索到的关键词,用来验证是否可用'],
+ 'Size' => ['title' => '默认请求、响应数据条数限制', 'description' => '默认请求、响应数据条数限制', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'SearchSourceRequestConfig' => [
+ 'title' => 'api请求配置',
+ 'description' => 'api请求配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => 'api地址', 'description' => 'api地址', 'type' => 'string', 'example' => 'api地址'],
+ 'Method' => ['title' => '请求方式', 'description' => '请求方式', 'type' => 'string', 'example' => '请求方式'],
+ 'ConnectTimeout' => ['title' => '连接超时时间:单位毫秒', 'description' => '连接超时时间', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
+ 'SocketTimeout' => ['title' => '读超时时间:单位毫秒', 'description' => '读超时时间', 'type' => 'integer', 'format' => 'int32', 'example' => '78'],
+ 'Headers' => [
+ 'description' => 'http请求头',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'http请求头',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => '参数名称'],
+ 'ValueType' => ['title' => '参数值数据类型: 默认string', 'description' => '参数值数据类型:默认string', 'type' => 'string', 'example' => '参数值数据类型:默认string'],
+ 'ValueFormat' => ['title' => 'valueType = time 时有效', 'description' => 'valueType = time 时有效', 'type' => 'string', 'example' => 'valueType = time 时有效'],
+ 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => '参数值'],
+ ],
+ ],
+ ],
+ 'Params' => [
+ 'title' => '请求path参数',
+ 'description' => '请求path参数',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '请求path参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'example' => '参数名称'],
+ 'ValueType' => ['title' => '参数值数据类型: 默认string', 'description' => '参数值数据类型:默认string', 'type' => 'string', 'example' => '参数值数据类型:默认string'],
+ 'ValueFormat' => ['title' => 'valueType = time 时有效', 'description' => 'valueType = time 时有效', 'type' => 'string', 'example' => 'valueType = time 时有效'],
+ 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'example' => '参数值'],
+ ],
+ ],
+ ],
+ 'PathParamsEnable' => ['title' => '是否开启pathParam', 'description' => '是否开启pathParam', 'type' => 'boolean', 'example' => 'true'],
+ 'Body' => ['title' => '请求body', 'description' => '请求body', 'type' => 'string', 'example' => '请求body'],
],
],
- ],
- 'Usage' => [
- 'title' => '用量',
- 'description' => '用量',
- 'type' => 'object',
- 'properties' => [
- 'OutputTokens' => [
- 'title' => '输出token',
- 'description' => '输出token',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'InputTokens' => [
- 'title' => '输入token',
- 'description' => '输入token',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TotalTokens' => [
- 'title' => '总token',
- 'description' => '总token',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '300',
+ 'SearchSourceResponseConfig' => [
+ 'title' => 'api响应配置',
+ 'description' => 'api响应配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'JqNodes' => [
+ 'title' => '节点配置',
+ 'description' => '节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '节点',
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'example' => '节点key'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => '节点数据类型:string number list object base', 'type' => 'string', 'example' => '节点数据类型:string number list object base'],
+ 'Path' => ['title' => '节点路径', 'description' => '节点路径', 'type' => 'string', 'example' => '节点路径'],
+ 'JqNodes' => [
+ 'title' => '子节点配置',
+ 'description' => '子节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '子节点配置',
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'example' => 'title'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => '节点数据类型:string number list object base', 'type' => 'string', 'example' => 'string'],
+ 'Path' => ['title' => '节点路径', 'description' => '节点路径', 'type' => 'string', 'example' => '.title'],
+ 'JqNodes' => [
+ 'title' => '子节点配置',
+ 'description' => '子节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '子节点配置',
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'example' => 'title'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => '节点数据类型:string number list object base', 'type' => 'string', 'example' => 'string'],
+ 'Path' => ['title' => '节点路径', 'description' => '节点路径', 'type' => 'string', 'example' => '.title'],
+ ],
+ ],
+ ],
+ ],
+ 'example' => 'xx',
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
],
],
],
+ 'SearchSourceConfig' => [
+ 'description' => '数据集配置项',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagSearchEnable' => ['description' => '标签是否参与搜索:默认true', 'type' => 'string', 'example' => 'true'],
+ 'TagGenerateEnable' => ['description' => '标签是否参与生成:默认true', 'type' => 'string', 'example' => 'true'],
+ 'MetadataKeyValueSearchEnable' => ['description' => 'metadata-keyValue 部分是否参与搜索:默认 true', 'type' => 'string', 'example' => 'true'],
+ 'MetadataKeyValueGenerateEnable' => ['description' => 'metadata-keyValue 部分是否参与生成:默认 true', 'type' => 'string', 'example' => 'true'],
+ ],
+ ],
],
],
- 'Status' => [
- 'title' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
- 'description' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'HtmlContent' => [
- 'title' => '格式化的审核时的内容',
- 'description' => '格式化的审核时的内容',
- 'type' => 'string',
- 'example' => '格式化的审核时的内容'."\n"
- ."\n",
- ],
- 'Title' => [
- 'title' => '内容标题',
- 'description' => '内容标题',
- 'type' => 'string',
- 'example' => '内容标题'."\n"
- ."\n",
+ 'DatasetDescription' => ['title' => '数据集显示名称', 'description' => '数据集显示名称', 'type' => 'string', 'example' => 'xxx'],
+ 'SearchDatasetEnable' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DocumentHandleConfig' => [
+ 'description' => '文档处理配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'DisableHandleMultimodalMedia' => ['title' => '禁用多媒体文件处理逻辑,默认为false', 'description' => '禁用多媒体文件处理逻辑,默认为false', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
+ 'AccessLevel' => ['title' => '开放类型: private(私有) shared(公开) public (公共)', 'type' => 'string', 'example' => 'private'],
],
],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskStatus\\": 1,\\n \\"Content\\": \\"审核时的原文\\",\\n \\"AuditTime\\": \\"2025-05-13 12:12:12\\",\\n \\"Response\\": {\\n \\"Header\\": {\\n \\"Event\\": \\"task-failed\\",\\n \\"ErrorCode\\": \\"DataNotExists\\",\\n \\"ErrorMessage\\": \\"数据不存在\\",\\n \\"SessionId\\": \\"49eab783-9172-487a-b9df-c6372c47392c\\",\\n \\"TaskId\\": \\"896b733535274d28b1a61c78bc145217\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"x\'x\'x\\"\\n },\\n \\"Usage\\": {\\n \\"OutputTokens\\": 100,\\n \\"InputTokens\\": 200,\\n \\"TotalTokens\\": 300\\n }\\n }\\n },\\n \\"Status\\": \\"RUNNING\\",\\n \\"HtmlContent\\": \\"格式化的审核时的内容\\\\n\\\\n\\",\\n \\"Title\\": \\"内容标题\\\\n\\\\n\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询审核结果',
- ],
- 'SubmitAuditTask' => [
- 'summary' => '提交审核任务',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetConfig\\": {\\n \\"SearchSourceConfigs\\": [\\n {\\n \\"DemoQuery\\": \\"可以搜索到的关键词,用来验证是否可用\\",\\n \\"Size\\": 10,\\n \\"SearchSourceRequestConfig\\": {\\n \\"Url\\": \\"api地址\\",\\n \\"Method\\": \\"请求方式\\",\\n \\"ConnectTimeout\\": 30,\\n \\"SocketTimeout\\": 78,\\n \\"Headers\\": [\\n {\\n \\"Name\\": \\"参数名称\\",\\n \\"ValueType\\": \\"参数值数据类型:默认string\\",\\n \\"ValueFormat\\": \\"valueType = time 时有效\\",\\n \\"Value\\": \\"参数值\\"\\n }\\n ],\\n \\"Params\\": [\\n {\\n \\"Name\\": \\"参数名称\\",\\n \\"ValueType\\": \\"参数值数据类型:默认string\\",\\n \\"ValueFormat\\": \\"valueType = time 时有效\\",\\n \\"Value\\": \\"参数值\\"\\n }\\n ],\\n \\"PathParamsEnable\\": true,\\n \\"Body\\": \\"请求body\\"\\n },\\n \\"SearchSourceResponseConfig\\": {\\n \\"JqNodes\\": [\\n {\\n \\"Key\\": \\"节点key\\",\\n \\"Type\\": \\"节点数据类型:string number list object base\\",\\n \\"Path\\": \\"节点路径\\",\\n \\"JqNodes\\": [\\n {\\n \\"Key\\": \\"title\\",\\n \\"Type\\": \\"string\\",\\n \\"Path\\": \\".title\\",\\n \\"JqNodes\\": [\\n {\\n \\"Key\\": \\"title\\",\\n \\"Type\\": \\"string\\",\\n \\"Path\\": \\".title\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"SearchSourceConfig\\": {\\n \\"TagSearchEnable\\": \\"true\\",\\n \\"TagGenerateEnable\\": \\"true\\",\\n \\"MetadataKeyValueSearchEnable\\": \\"true\\",\\n \\"MetadataKeyValueGenerateEnable\\": \\"true\\"\\n }\\n },\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1,\\n \\"DocumentHandleConfig\\": {\\n \\"DisableHandleMultimodalMedia\\": true\\n },\\n \\"AccessLevel\\": \\"private\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'GetDatasetDocument' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ArticleId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '审核时的文章ID',
- 'description' => '审核时的文章ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'Content',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'schema' => [
- 'title' => '待审核的内容',
- 'description' => '待审核的内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '待审核的内容'."\n"
- ."\n",
- ],
+ 'schema' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => '数据集名称'],
],
[
- 'name' => 'HtmlContent',
+ 'name' => 'DocUuid',
'in' => 'formData',
- 'schema' => [
- 'title' => '审核时的 HTML格式 的内容',
- 'description' => '审核时的 HTML格式 的内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '待审核的内容(HTML格式)',
- ],
+ 'schema' => ['description' => '内部文档唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'Title',
+ 'name' => 'DocId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档-自定义的唯一ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'IncludeFields',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '审核时的文章标题',
- 'description' => '审核时的文章标题',
- 'type' => 'string',
+ 'title' => '包含的字段列表',
+ 'description' => '包含的字段列表',
+ 'type' => 'array',
+ 'items' => ['title' => '包含的字段:比如metadata', 'description' => '包含的字段:比如 metadata', 'type' => 'string', 'required' => false, 'example' => 'metadata'],
'required' => false,
- 'example' => '审核时的文章标题'."\n"
- ."\n",
],
],
],
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'xx',
+ 'DocUuid' => ['title' => '内部文档唯一ID', 'description' => '文档系统唯一ID', 'type' => 'string', 'example' => 'xxx'],
+ 'Url' => ['description' => '文章URL', 'type' => 'string', 'example' => 'https://www.aliyun.com'],
+ 'Content' => ['description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '文档标题'."\n"
+ ."\n"],
+ 'PubTime' => ['description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-05-14 08:54:33'],
+ 'SourceFrom' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '来源'],
+ 'DisableHandleMultimodalMedia' => ['title' => '当前记录是否落多模态索引库', 'description' => '当前记录是否落多模态索引库', 'type' => 'boolean', 'example' => 'true'],
+ 'DocId' => ['title' => '用户指定的文档唯一ID', 'description' => '文档用户侧唯一ID', 'type' => 'string', 'example' => 'xxx'],
+ 'Metadata' => [
+ 'title' => '字典信息',
+ 'description' => '字典信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '文档维度meta', 'description' => '文档维度meta', 'type' => 'string', 'example' => 'xx'],
+ 'VideoShots' => [
+ 'title' => '视频分片信息',
+ 'description' => '视频分片信息',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '视频分片信息',
+ 'description' => '视频分片信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['title' => '视频分片开始时间:毫秒', 'description' => '视频分片开始时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'EndTime' => ['title' => '视频分片结束时间:毫秒', 'description' => '视频分片结束时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'Text' => ['title' => '视频分片:内容', 'description' => '视频分片:内容', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ ],
+ ],
+ 'AsrSentences' => [
+ 'title' => 'asr结果',
+ 'description' => 'asr结果',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => 'asr结果',
+ 'description' => 'asr结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'StartTime' => ['title' => '开始时间:毫秒', 'description' => '开始时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'EndTime' => ['title' => '结束时间:毫秒', 'description' => '结束时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'],
+ 'Text' => ['title' => 'asr内容', 'description' => 'asr内容', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ ],
+ ],
+ 'KeyValues' => [
+ 'description' => 'key-value结构的metadata',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'keyValue结构metadata',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '参数名称', 'type' => 'string', 'example' => 'xx'],
+ 'Value' => ['description' => '参数值', 'type' => 'string', 'example' => 'xx'],
+ ],
+ ],
+ ],
+ ],
],
+ 'DocType' => ['title' => '文档类型:比如video、image', 'description' => '文档类型:比如video、image', 'type' => 'string', 'example' => 'video'],
+ 'Status' => ['title' => '文档状态', 'description' => '文档状态:100:成功 0:失败 1:索引或排队中', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Tags' => [
+ 'description' => '标签。',
+ 'type' => 'array',
+ 'items' => ['description' => '标签。', 'type' => 'string', 'example' => 'xx'],
+ ],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xx\\"\\n }\\n}","type":"json"}]',
- 'title' => '提交审核任务',
- ],
- 'CancelAuditTask' => [
- 'summary' => '取消审核任务',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-获取文档详情',
+ 'summary' => '获取数据源文档。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DocUuid\\": \\"xxx\\",\\n \\"Url\\": \\"https://www.aliyun.com\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Title\\": \\"文档标题\\\\n\\\\n\\",\\n \\"PubTime\\": \\"2024-05-14 08:54:33\\",\\n \\"SourceFrom\\": \\"来源\\",\\n \\"DisableHandleMultimodalMedia\\": true,\\n \\"DocId\\": \\"xxx\\",\\n \\"Metadata\\": {\\n \\"Text\\": \\"xx\\",\\n \\"VideoShots\\": [\\n {\\n \\"StartTime\\": 1000,\\n \\"EndTime\\": 2000,\\n \\"Text\\": \\"xxx\\"\\n }\\n ],\\n \\"AsrSentences\\": [\\n {\\n \\"StartTime\\": 1000,\\n \\"EndTime\\": 2000,\\n \\"Text\\": \\"xxx\\"\\n }\\n ],\\n \\"KeyValues\\": [\\n {\\n \\"Key\\": \\"xx\\",\\n \\"Value\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"DocType\\": \\"video\\",\\n \\"Status\\": 100,\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'GetDeepWriteTask' => [
+ 'summary' => '查询深度写作任务。'."\n"
+ .'主要用来查询指定任务的运行状态。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'ContentAuditTaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '审核任务ID(任务ID与文章ID二选一)',
- 'description' => '审核任务ID(任务ID与文章ID二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'ArticleId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文章ID(任务ID与文章ID二选一)',
- 'description' => '文章ID(任务ID与文章ID二选一)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-odl2p61i4vfbph4g'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '6d3c0bc9-7561-41a4-be4c-d906abdb40a9'],
],
],
'responses' => [
@@ -12946,398 +7840,226 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'title' => '是否取消成功',
- 'description' => '是否取消成功',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'a2267372-6042-46a4-aab0-1670dfc38c94'],
+ 'Input' => ['title' => '用户的问题', 'description' => '用户的问题', 'type' => 'string', 'example' => '北京2025年新能源汽车发展趋势'],
+ 'Status' => [
+ 'title' => '任务状态',
+ 'description' => '任务状态',
+ 'type' => 'string',
+ 'enumValueTitles' => ['in_progress' => '运行中', 'queued' => '排队中', 'cancelled' => '已取消', 'completed' => '已完成', 'failed' => '失败'],
+ 'example' => 'queued',
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true\\n}","type":"json"}]',
- 'title' => '取消审核任务',
- ],
- 'SubmitSmartAudit' => [
- 'summary' => '提交智能审核',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询深度写作任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDeepWriteTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"a2267372-6042-46a4-aab0-1670dfc38c94\\",\\n \\"Input\\": \\"北京2025年新能源汽车发展趋势\\",\\n \\"Status\\": \\"queued\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetDeepWriteTaskResult' => [
+ 'summary' => '查询深度写作任务的结果。'."\n"
+ .'如果指定任务没有执行完成(排队、执行中、失败、取消等),会返回当前执行状态。如果指定任务已完成,会以URL的形式返回该任务的产出物的压缩包,供用户下载查看。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-1setzb9xb8m11vrc'],
],
[
- 'name' => 'Text',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待审核的内容',
- 'description' => '待审核的内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '“你好呀”',
- ],
- ],
- [
- 'name' => 'SubCodes',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '子审核编码列表',
- 'type' => 'array',
- 'items' => [
- 'title' => 'ImageAudit表示图片审核',
- 'description' => '子审核编码,子审核编码详见接口 [ListAuditContentErrorTypes](~~2929521~~)或下述参数补充说明',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'PunctuationError',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => 'xbabac91-fdad-44d6-95ce-******'],
],
- [
- 'name' => 'imageUrls',
- 'in' => 'formData',
- 'style' => 'json',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '图片审核时传递的参数',
- 'description' => '图片审核时传递的参数(已弃用,请使用ImageUrlList)',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片审核时传递的参数',
- 'type' => 'object',
- 'properties' => [
- 'url' => [
- 'title' => 'Url可能是链接,可能是base64',
- 'description' => 'Url可能是链接,可能是base64',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/xxx.jpg',
- ],
- 'id' => [
- 'title' => '图片唯一标识ID',
- 'description' => '图片唯一标识ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3HAZTv62M0vkyz5B',
+ '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'f8707efa-c30e-407f-a611-50871aa68952'],
+ 'ArtifactUrl' => ['title' => '任务结果下载地址', 'description' => '任务结果下载地址', 'type' => 'string', 'example' => 'https://aimiaobi-service-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/aimiaobi/deep-write-workspace/142***1/dbaaebd1-eb1b-41e8-9b99-******-result.zip?Expire=1111'],
],
],
- 'required' => false,
],
- 'required' => false,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询深度写作任务的结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ImageUrlList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '图片审核时传递的参数',
- 'description' => '图片审核时传递的参数',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => 'Url可能是链接,可能是base64',
- 'description' => 'Url可能是链接,可能是base64',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxx.png',
- ],
- 'Id' => [
- 'title' => '图片唯一标识ID',
- 'description' => '图片唯一标识ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- 'required' => false,
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDeepWriteTaskResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"f8707efa-c30e-407f-a611-50871aa68952\\",\\n \\"ArtifactUrl\\": \\"https://aimiaobi-service-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/aimiaobi/deep-write-workspace/142***1/dbaaebd1-eb1b-41e8-9b99-******-result.zip?Expire=1111\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetDocClusterTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NoteId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '基于规则库审校的规则库ID(默认 Default)',
- 'description' => '基于规则库审校的规则库ID(默认 Default)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'note_1_486',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
- 'name' => 'TermsName',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '基于词库审校的词库名称(默认 Default)',
- 'description' => '基于词库审校的词库名称(默认 Default)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Default',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => '93771c8e1142467fb1aedf1763feba1e'],
],
],
'responses' => [
200 => [
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Status' => [
+ 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'description' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
'type' => 'string',
- 'example' => 'xxxx',
+ 'example' => 'PENDING',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
+ ],
+ 'Topics' => [
+ 'title' => '聚类主题列表',
+ 'description' => '聚类主题列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '热点事件对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocIds' => [
+ 'title' => '聚类主题下的文档ID列表',
+ 'description' => '聚类主题下的文档ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'example' => 'xxxxx'],
+ ],
+ 'Summary' => ['title' => '聚类主题摘要', 'description' => '聚类主题摘要', 'type' => 'string', 'example' => '聚类主题摘要'],
+ 'Title' => ['title' => '聚类主题名', 'description' => '聚类主题名', 'type' => 'string', 'example' => '聚类主题名'],
+ ],
+ ],
],
],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxx\\"\\n }\\n}","type":"json"}]',
- 'title' => '提交智能审校任务',
- 'description' => '# 支持的审核类型'."\n"
- ."\n"
- .'## 审校大类概览'."\n"
- ."\n"
- .'| 审校大类 | 说明 |'."\n"
- .'| -------- | -------- |'."\n"
- .'| 内容准确性 | 音/形相似差错;标点符号错误;的地得错误;用词不当/语法错误;人名错误;地名错误;引用错误;专有名称/术语错误 |'."\n"
- .'| 格式规范问题 | 大小写不规范;数字错误;计量单位不规范;繁体字 |'."\n"
- .'| 内容结构问题 | 文字冗余;片段重复;逻辑矛盾;占位符未填充 |'."\n"
- .'| 政治性问题 | 敏感和内容导向风险;姓名或排序差错;固有表述差错;机构名称不规范;重要讲话引用差错;落马官员;姓名职务搭配错误;职务表述错误 |'."\n"
- .'| 安全合规问题 | 暴恐;色情;违禁;侮辱;劣迹艺人;个人隐私;报道规范 |'."\n"
- .'| 法律错误 | 法律法规引用;法律条文错误 |'."\n"
- .'| 其他专业知识错误 | 违反广告法;金融类信息;科技名词 |'."\n"
- .'| 事实性检查 | 事实性审核正确项/错误项 |'."\n"
- .'| 图片审核 | 图片内容审核 |'."\n"
- .'| 自定义词库 | 自定义词库审核 |'."\n"
- .'| 规则库审核 | 规则库审核 |'."\n"
- .'| 英文审校 | 术语标准化;动词时态准确性;标点与引号;拼写与语言变体;句子结构与清晰度;数字与百分比格式;规范用语 |'."\n"
- ."\n"
- .'---'."\n"
- ."\n"
- .'## 子审核编码取值列表'."\n"
- ."\n"
- .'### 1. 内容准确性'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 音/形相似差错 | PhoneticSimilarError |'."\n"
- .'| 标点符号错误 | PunctuationError |'."\n"
- .'| 的地得错误 | ParticleUsageError |'."\n"
- .'| 用词不当/语法错误 | WordError |'."\n"
- .'| 人名错误 | PersonNameError |'."\n"
- .'| 地名错误 | LocationError |'."\n"
- .'| 引用错误 | ReferenceError |'."\n"
- .'| 专有名称/术语错误 | NounItemError |'."\n"
- ."\n"
- .'### 2. 格式规范问题'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 大小写不规范 | CapitalizationError |'."\n"
- .'| 数字错误 | NumberError |'."\n"
- .'| 计量单位不规范 | UnitError |'."\n"
- .'| 繁体字 | TraditionalChineseError |'."\n"
- ."\n"
- .'### 3. 内容结构问题'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 文字冗余 | WordRedundancy |'."\n"
- .'| 片段重复 | DuplicateError |'."\n"
- .'| 逻辑矛盾 | LogicContradiction |'."\n"
- .'| 占位符未填充 | PlaceholderNotFilled |'."\n"
- ."\n"
- .'### 4. 政治性问题'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 敏感和内容导向风险 | SensitiveContentRisk |'."\n"
- .'| 姓名或排序差错 | NameOrderError |'."\n"
- .'| 固有表述差错 | ConventionalExpressionError |'."\n"
- .'| 机构名称不规范 | DepartmentNameError |'."\n"
- .'| 重要讲话引用差错 | ImportantSpeechError |'."\n"
- .'| 落马官员 | FallenOfficialError |'."\n"
- .'| 姓名职务搭配错误 | LeaderTitleMatchError |'."\n"
- .'| 职务表述错误 | TitleError |'."\n"
- ."\n"
- .'### 5. 安全合规问题'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 暴恐 | ViolenceTerrorismError |'."\n"
- .'| 色情 | PornographyError |'."\n"
- .'| 违禁 | ProhibitedContentError |'."\n"
- .'| 侮辱 | InsultError |'."\n"
- .'| 劣迹艺人 | DisgracedArtistError |'."\n"
- .'| 个人隐私 | PersonalPrivacyError |'."\n"
- .'| 报道规范 | ReportingStandardError |'."\n"
- ."\n"
- .'### 6. 法律错误'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 法律法规引用 | LegalReferenceError |'."\n"
- .'| 法律条文错误 | LegalProvisionsError |'."\n"
- ."\n"
- .'### 7. 其他专业知识错误'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 违反广告法 | AdvertisingProhibitedWordsError |'."\n"
- .'| 金融类信息 | FinancialInformationError |'."\n"
- .'| 科技名词 | TechnicalTermError |'."\n"
- ."\n"
- .'### 8. 事实性检查'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 事实性审核-正确项 | CorrectFact |'."\n"
- .'| 事实性审核-错误项 | WrongFactError |'."\n"
- ."\n"
- .'### 9. 图片审核'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 图片审核 | ImageAudit |'."\n"
- ."\n"
- .'### 10. 自定义词库'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 自定义词库 | WordLibrary |'."\n"
- ."\n"
- .'### 11. 规则库审核'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 规则库审核 | WrongQuestionBook |'."\n"
- ."\n"
- .'### 12. 英文审校'."\n"
- ."\n"
- .'| 描述 | code |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 术语标准化 | TerminologyNormalisation |'."\n"
- .'| 动词时态准确性 | VerbTenseAccuracy |'."\n"
- .'| 标点与引号 | PunctuationAndQuotationMarks |'."\n"
- .'| 拼写与语言变体 | SpellingAndLanguageVariety |'."\n"
- .'| 句子结构与清晰度 | SentenceStructureAndClarity |'."\n"
- .'| 数字与百分比格式 | NumericAndPercentageStyle |'."\n"
- .'| 其他规范用语 | Others |',
- ],
- 'GetSmartAuditResult' => [
- 'summary' => '查询智能审核结果',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取内容聚合任务结果',
+ 'summary' => '获取内容聚合任务结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDocClusterTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"Topics\\": [\\n {\\n \\"DocIds\\": [\\n \\"xxxxx\\"\\n ],\\n \\"Summary\\": \\"聚类主题摘要\\",\\n \\"Title\\": \\"聚类主题名\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetDocInfo' => [
+ 'summary' => '妙读获取文档信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13345,33 +8067,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档所在目录', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
],
'responses' => [
@@ -13381,165 +8092,76 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'Code' => ['description' => '内部错误码', 'type' => 'string', 'example' => 'successful', 'title' => '内部错误码'],
'Data' => [
- 'description' => '审核结果',
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
- 'description' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'ErrorItemDetails' => [
- 'description' => '审核错误明细列表',
+ 'DocName' => ['description' => '文档名称', 'type' => 'string', 'example' => '電視廣播2020年報', 'title' => '文档名称'],
+ 'DocType' => ['description' => '文档类型', 'type' => 'string', 'example' => 'pdf', 'title' => '文档类型'],
+ 'FileUrl' => ['description' => '文件url', 'type' => 'string', 'example' => 'http://xxx/xxx.pdf', 'title' => '文件url'],
+ 'Status' => ['description' => '任务状态信息', 'type' => 'integer', 'format' => 'int32', 'example' => '1和0,当状态为1时 表示获取文档成功,用户可进行生成文档摘要、生脑图等操作', 'title' => '任务状态信息'],
+ 'StatusMessage' => ['description' => '状态消息', 'type' => 'string', 'example' => '导入成功', 'title' => '状态消息'],
+ 'VideoContents' => [
+ 'description' => '视频中的语音内容文本数组',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Context' => [
- 'title' => '原文片段',
- 'description' => '原文片段',
- 'type' => 'string',
- 'example' => '原文片段',
- ],
- 'MajorCodeDesc' => [
- 'title' => '主错误描述',
- 'description' => '主错误描述',
- 'type' => 'string',
- 'example' => '内容准确性',
- ],
- 'ErrorWord' => [
- 'title' => '错误单词',
- 'description' => '错误单词',
- 'type' => 'string',
- 'example' => '”xxx“',
- ],
- 'MajorCode' => [
- 'title' => '主错误码',
- 'description' => '主错误码',
- 'type' => 'string',
- 'example' => 'ContentAccuracy',
- ],
- 'RightWord' => [
- 'title' => '推荐修改的单词',
- 'description' => '推荐修改的单词',
- 'type' => 'string',
- 'example' => '“xxx”',
- ],
- 'Reason' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '中文双引号应成对正确使用,先左双引号,后右双引号',
- ],
- 'Url' => [
- 'title' => '图片审核场景下,返回命中审核的可访问的图片的公网地址',
- 'description' => '图片审核场景下,返回命中审核的可访问的图片的公网地址',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxxx.jpg',
- ],
- 'Offset' => [
- 'title' => '错误单词在全文的偏移索引',
- 'description' => '错误单词在全文的偏移索引',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'CheckId' => [
- 'title' => '审核项唯一标识。(图片审核场景下为图片的ID)',
- 'description' => '审核项唯一标识。',
- 'type' => 'string',
- 'example' => '审核项唯一标识。'."\n"
- ."\n",
- ],
- 'SubClassCode' => [
- 'title' => '子错误码',
- 'description' => '子错误码',
- 'type' => 'string',
- 'example' => 'PunctuationError',
- ],
- 'ErrorLevel' => [
- 'title' => '错误等级(1-严重,2-警告,3-提示,4-建议)',
- 'description' => '错误等级(1-严重,2-警告,3-提示,4-建议)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'SubClassDesc' => [
- 'title' => '子错误描述',
- 'description' => '子错误描述',
- 'type' => 'string',
- 'example' => '标点符号错误'."\n",
- ],
- 'ContextOffset' => [
- 'title' => '错误单词在上下文(Context)中的偏移索引。',
- 'description' => '错误单词在上下文(Context)中的偏移索引。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- ],
- ],
+ 'items' => ['description' => '视频中的语音内容文本', 'type' => 'string', 'example' => '文本内容', 'title' => '视频中的语音内容文本'],
+ 'title' => '视频中的语音内容文本',
],
- 'ErrorMessage' => [
- 'title' => '审核错误信息',
- 'description' => 'Status最终状态 不为SUCCESSED 时,需要读取此错误信息,判断错误',
- 'type' => 'string',
- 'example' => '审核被取消',
+ 'CategoryId' => ['description' => '文档所在目录', 'type' => 'string', 'example' => 'default', 'title' => '文档所在目录'],
+ 'PageInfo' => [
+ 'title' => '当前页加载的数据内容。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Width' => ['title' => '缩略图宽度,单位px。', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Height' => ['title' => '图片高度,单位:像素。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ 'title' => '返回数据',
],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => 'http状态码'],
+ 'Message' => ['description' => '返回结果消息', 'type' => 'string', 'example' => 'successful', 'title' => '返回结果消息'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true', 'title' => '是否成功'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ErrorItemDetails\\": [\\n {\\n \\"Context\\": \\"原文片段\\",\\n \\"MajorCodeDesc\\": \\"内容准确性\\",\\n \\"ErrorWord\\": \\"”xxx“\\",\\n \\"MajorCode\\": \\"ContentAccuracy\\",\\n \\"RightWord\\": \\"“xxx”\\",\\n \\"Reason\\": \\"中文双引号应成对正确使用,先左双引号,后右双引号\\",\\n \\"Url\\": \\"http://www.example.com/xxxx.jpg\\",\\n \\"Offset\\": 0,\\n \\"CheckId\\": \\"审核项唯一标识。\\\\n\\\\n\\",\\n \\"SubClassCode\\": \\"PunctuationError\\",\\n \\"ErrorLevel\\": 2,\\n \\"SubClassDesc\\": \\"标点符号错误\\\\n\\",\\n \\"ContextOffset\\": 0\\n }\\n ],\\n \\"ErrorMessage\\": \\"审核被取消\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询智能审校结果',
- ],
- 'ListAuditContentErrorTypes' => [
- 'summary' => '获取审核维度列表',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => '获取文档信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDocInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DocName\\": \\"電視廣播2020年報\\",\\n \\"DocType\\": \\"pdf\\",\\n \\"FileUrl\\": \\"http://xxx/xxx.pdf\\",\\n \\"Status\\": 0,\\n \\"StatusMessage\\": \\"导入成功\\",\\n \\"VideoContents\\": [\\n \\"文本内容\\"\\n ],\\n \\"CategoryId\\": \\"default\\",\\n \\"PageInfo\\": {\\n \\"Width\\": 100,\\n \\"Height\\": 200\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetEnterpriseVocAnalysisTask' => [
+ 'summary' => '获取企业VOC分析任务结果。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13547,172 +8169,197 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'MaxResults',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '最大记录数',
- 'description' => '最大记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '2000',
- 'minimum' => '0',
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'NextToken',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页Token',
- 'description' => '下一页Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cEoBWREAXdxaOyjq/cqAbg==',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
],
],
'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' => 'xxxxx',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'HTTP状态码',
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '审核维度列表',
- 'description' => '审核维度列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '主审核维度',
- 'description' => '主审核维度',
- 'type' => 'object',
- 'properties' => [
- 'MajorClassCode' => [
- 'title' => '主审核维度Code',
- 'description' => '主审核维度Code',
- 'type' => 'string',
- 'example' => 'ContentAccuracy',
- ],
- 'SubClasses' => [
- 'title' => '子审核维度列表',
- 'description' => '子审核维度列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '子审核维度',
- 'description' => '子审核维度',
+ 'title' => '企业VOC分析结果',
+ 'description' => '企业VOC分析结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'StatisticsOverview' => [
+ 'title' => '统计概览',
+ 'description' => '统计概览',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['title' => '总分析数据条数', 'description' => '总分析数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'TagDimensionStatistics' => [
+ 'title' => '内容标签统计',
+ 'description' => '内容标签统计',
'type' => 'object',
'properties' => [
- 'ClassCode' => [
- 'title' => '子审核维度Code',
- 'description' => '子审核维度Code',
- 'type' => 'string',
- 'example' => 'PunctuationError',
+ 'TagValueCountStatistic' => [
+ 'title' => '标签值数量统计',
+ 'description' => '标签值数量统计',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'example' => 'xxx'],
+ 'TagTaskType' => ['title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)', 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)', 'type' => 'string', 'example' => 'multiTagValues'],
+ 'ValueCount' => ['title' => '标签值数量', 'description' => '标签值数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ 'description' => '',
+ ],
],
- 'ClassName' => [
- 'title' => '子审核维度名称',
- 'description' => '子审核维度名称',
- 'type' => 'string',
- 'example' => '标点符号错误',
+ ],
+ ],
+ 'FilterDimensionStatistics' => [
+ 'title' => '筛选标签统计',
+ 'description' => '筛选标签统计',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagValueCountStatistic' => [
+ 'title' => '标签值数量统计',
+ 'description' => '标签值数量统计',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'example' => 'xxx'],
+ 'TagTaskType' => ['title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)', 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)', 'type' => 'string', 'example' => 'multiTagValues'],
+ 'ValueCount' => ['title' => '标签值数量', 'description' => '标签值数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ 'description' => '',
+ ],
],
],
],
],
- 'MajorClassName' => [
- 'title' => '子审核维度名称',
- 'description' => '子审核维度名称',
- 'type' => 'string',
- 'example' => '内容准确性',
+ ],
+ 'Usage' => [
+ 'title' => '消耗量统计',
+ 'description' => '消耗量统计',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutputTokens' => ['title' => '输出token数', 'description' => '输出token数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'InputTokens' => ['title' => '输入token数', 'description' => '输入token数', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
+ 'Status' => ['title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)', 'type' => 'string', 'example' => 'SUCCESSED'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => 'error'],
],
],
- 'NextToken' => [
- 'title' => '下一页Token',
- 'description' => '下一页Token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'TotalCount' => [
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'MaxResults' => [
- 'title' => '当前返回的最大记录数',
- 'description' => '当前返回的最大记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取企业VOC挖掘任务结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"MajorClassCode\\": \\"ContentAccuracy\\",\\n \\"SubClasses\\": [\\n {\\n \\"ClassCode\\": \\"PunctuationError\\",\\n \\"ClassName\\": \\"标点符号错误\\"\\n }\\n ],\\n \\"MajorClassName\\": \\"内容准确性\\"\\n }\\n ],\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
- 'title' => '获取审校维度列表',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"StatisticsOverview\\": {\\n \\"Count\\": 100,\\n \\"TagDimensionStatistics\\": {\\n \\"TagValueCountStatistic\\": [\\n {\\n \\"TagName\\": \\"xxx\\",\\n \\"TagTaskType\\": \\"multiTagValues\\",\\n \\"ValueCount\\": 100\\n }\\n ]\\n },\\n \\"FilterDimensionStatistics\\": {\\n \\"TagValueCountStatistic\\": [\\n {\\n \\"TagName\\": \\"xxx\\",\\n \\"TagTaskType\\": \\"multiTagValues\\",\\n \\"ValueCount\\": 100\\n }\\n ]\\n }\\n },\\n \\"Usage\\": {\\n \\"OutputTokens\\": 100,\\n \\"InputTokens\\": 200\\n },\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ErrorMessage\\": \\"error\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ExportAuditContentResult' => [
- 'summary' => '导出智能审核报告',
- 'methods' => [
- 'post',
+ 'GetFactAuditUrl' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => [
+ 'title' => '当前正用于事实性审核的信源 URL 列表。当列表中没有 URL 时,检索信源为全网;有 URL 时,只从配置好的 URL 中获取信息。删除不需要的信源 URL 时,请使用出参中的 URL 填写到 DeleteFactAuditUrl 接口的入参。',
+ 'description' => '当前正用于事实性审核的信源 URL 列表。当列表中没有 URL 时,检索信源为全网;有 URL 时,只从配置好的 URL 中获取信息。删除不需要的信源 URL 时,请使用出参中的 URL 填写到 DeleteFactAuditUrl 接口的入参。',
+ 'type' => 'array',
+ 'items' => ['description' => '返回的数据内容。', 'type' => 'string', 'example' => 'aliyun.com'],
+ 'required' => true,
+ 'maxItems' => 10,
+ 'minItems' => 0,
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取事实性审核 URL',
+ 'summary' => '获取当前正用于事实性审核的信源 URL。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetFactAuditUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n \\"aliyun.com\\"\\n ]\\n}","type":"json"}]',
+ ],
+ 'GetFileContentLength' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13720,33 +8367,22 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'DocName',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
- ],
+ 'schema' => ['description' => '文档名称', 'type' => 'string', 'required' => false, 'example' => 'test.pdf'],
+ ],
+ [
+ 'name' => 'FileUrl',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文件地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxx/test.pdf'],
],
],
'responses' => [
@@ -13756,62 +8392,52 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'title' => 'HTTP状态码',
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '返回word格式的可公开访问的URL(1小时失效)',
- 'description' => '返回word格式(.docx)的可公开访问的URL(1小时失效)',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.docx',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'WordNum' => ['description' => '文件长度', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'],
+ ],
],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '返回信息。', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'True'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": \\"http://www.example.com/xxx.docx\\"\\n}","type":"json"}]',
- 'title' => '导出智能审校报告',
- ],
- 'GenerateExportWordTask' => [
- 'summary' => '生成内容导出文档任务',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取文件长度',
+ 'summary' => '妙读获得文档字数。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetFileContentLength',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD656AF9-0839-521A-A3D2-F320009F9C87\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"WordNum\\": 1024\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetGeneralConfig' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13819,108 +8445,72 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-'],
],
[
- 'name' => 'GeneratedContentId',
+ 'name' => 'ConfigKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '配置唯一标识', 'description' => '配置唯一标识', 'type' => 'string', 'required' => true, 'example' => 'xx'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => '响应结果',
'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'description' => '返回内容',
+ 'title' => '结果',
+ 'description' => '结果',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'ConfigKey' => ['title' => '配置唯一标识', 'description' => '配置唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigValue' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigValueType' => ['title' => '配置值类型', 'description' => '配置值类型', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigDesc' => ['title' => '配置描述', 'description' => '配置描述', 'type' => 'string', 'example' => 'xx'],
],
],
- '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',
- ],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '生成导出文档任务',
- ],
- 'FetchExportWordTask' => [
- 'summary' => '获取异步导出文档任务结果',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通用配置-详情',
+ 'summary' => '通用配置-查询。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xx\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetGeneratedContent' => [
+ 'summary' => '获取文档:用来查询妙笔中创作的文章历史。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -13928,32 +8518,17 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2e27abb32cb64f80a0c6e829b6c87a09',
- ],
+ 'schema' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
],
],
'responses' => [
@@ -13964,542 +8539,803 @@
'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'description' => '返回数据。',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'FileUrl' => [
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.xls',
- ],
- 'TaskStats' => [
- 'description' => '任务状态',
- 'type' => 'string',
- 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消',
+ 'Content' => ['title' => '正文:富文本', 'description' => '正文:富文本', 'type' => 'string', 'example' => '杭州亚运会'],
+ 'ContentDomain' => ['title' => '内容生成的领域-media:新闻、government:政务', 'description' => '内容生成的领域-media:新闻、government:政务', 'type' => 'string', 'example' => 'media'],
+ 'ContentText' => ['title' => '正文:纯文本', 'description' => '正文:纯文本', 'type' => 'string', 'example' => '杭州亚运会'],
+ 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2024-01-04 11:46:07'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '"1"'],
+ 'DeviceId' => ['title' => '设备ID', 'description' => '设备ID', 'type' => 'string', 'example' => 'xxx'],
+ 'Id' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '86'],
+ 'KeywordList' => [
+ 'title' => '关键词',
+ 'description' => '关键词',
+ 'type' => 'array',
+ 'items' => ['description' => '关键词', 'type' => 'string', 'example' => '观点'],
],
+ 'Keywords' => ['title' => '关键词(string)', 'description' => '关键词(string)', 'type' => 'string', 'example' => '[\\"教师\\",\\"乡村\\"]'],
+ 'Prompt' => ['title' => '最后一次生成的提示词', 'description' => '最后一次生成的提示词', 'type' => 'string', 'example' => '创作xxx文章'],
+ 'TaskId' => ['title' => '会话任务唯一标识', 'description' => '会话任务唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '杭州亚运会'],
+ 'UpdateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2024-01-04 11:46:07'],
+ 'UpdateUser' => ['title' => '更新者', 'description' => '更新者', 'type' => 'string', 'example' => '"1"'],
+ 'Uuid' => ['title' => 'UUID 溯源唯一标识', 'description' => 'UUID 溯源唯一标识', 'type' => 'string', 'example' => '0961a514-2e26-4aa6-b22b-f592d145fe47'],
+ 'IgnoreContentAuditWords' => ['title' => '审核忽略的单词对象列表', 'description' => '审核忽略的单词对象列表(json字符串)', 'type' => 'string', 'example' => '"[{}]"'],
],
],
- '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',
- ],
+ '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'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取文档',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-23T01:59:01.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://xxx/xxx.xls\\",\\n \\"TaskStats\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取导出文档任务结果',
- ],
- 'CreateGeneratedContent' => [
- 'summary' => '保存文档:用来保存妙笔中创作的文章,支持富文本。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetGeneratedContent'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Content\\": \\"杭州亚运会\\",\\n \\"ContentDomain\\": \\"media\\",\\n \\"ContentText\\": \\"杭州亚运会\\",\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"CreateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"DeviceId\\": \\"xxx\\",\\n \\"Id\\": 86,\\n \\"KeywordList\\": [\\n \\"观点\\"\\n ],\\n \\"Keywords\\": \\"[\\\\\\\\\\\\\\"教师\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"乡村\\\\\\\\\\\\\\"]\\",\\n \\"Prompt\\": \\"创作xxx文章\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Title\\": \\"杭州亚运会\\",\\n \\"UpdateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"UpdateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"Uuid\\": \\"0961a514-2e26-4aa6-b22b-f592d145fe47\\",\\n \\"IgnoreContentAuditWords\\": \\"\\\\\\"[{}]\\\\\\"\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetHotTopicBroadcast' => [
+ 'summary' => '查询新闻播报单。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'HotTopicVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '最后一次生成的提示词',
- 'description' => '最后一次生成的提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '创作xxx文章',
- ],
+ 'schema' => ['title' => '热点版本', 'description' => '热点版本', 'type' => 'string', 'required' => false, 'example' => '2024-10-11_13'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Topics',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '会话任务唯一标识',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- 'maxLength' => 64,
- 'minLength' => 6,
+ 'title' => '话题筛选',
+ 'description' => '话题筛选',
+ 'type' => 'array',
+ 'items' => ['description' => '热点主题', 'type' => 'string', 'required' => false, 'example' => '["主题1","主题2"]'],
+ 'required' => false,
+ 'example' => '["主题1","主题2"]',
],
],
[
- 'name' => 'Title',
+ 'name' => 'CalcTotalToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '杭州亚运会',
- 'maxLength' => 200,
- 'minLength' => 2,
- ],
+ 'schema' => ['title' => '是否计算总Token数', 'description' => '是否计算总Token数', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'Content',
+ 'name' => 'Category',
'in' => 'formData',
- 'schema' => [
- 'title' => '正文:富文本',
- 'description' => '正文:富文本',
- 'type' => 'string',
- 'required' => true,
- 'example' => '杭州亚运会',
- ],
+ 'schema' => ['title' => '分类筛选', 'description' => '分类筛选', 'type' => 'string', 'required' => false, 'example' => '分类筛选'],
],
[
- 'name' => 'ContentDomain',
+ 'name' => 'StepForNewsBroadcastContentConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '内容生成的领域',
- 'description' => '内容生成的领域',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'government',
- 'default' => 'media',
- 'enum' => [
- 'media',
- 'government',
- 'hottopic',
- 'custom',
- 'office',
- 'market',
+ 'title' => '热点播报单内容配置',
+ 'description' => '热点播报单内容配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Categories' => [
+ 'title' => '选择的频道列表',
+ 'description' => '选择的频道列表',
+ 'type' => 'array',
+ 'items' => ['description' => '频道', 'type' => 'string', 'required' => false, 'example' => '["科技","经济","时政","娱乐"]'],
+ 'required' => false,
+ 'example' => '["科技","经济","时政","娱乐"]',
+ ],
+ 'CustomHotValueWeights' => [
+ 'title' => '自定义热度权重(此参数已过时,不生效。不用传递此参数)',
+ 'description' => '自定义热度权重',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义权重',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['title' => '维度KEY', 'description' => '维度KEY', 'type' => 'string', 'required' => false, 'example' => 'views'],
+ 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'deprecated' => true,
+ 'required' => false,
+ ],
+ 'TopicCount' => ['title' => '话题数量', 'description' => '话题数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
+ 'required' => false,
],
],
[
- 'name' => 'ContentText',
+ 'name' => 'StepForCustomSummaryStyleConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '正文:纯文本',
- 'description' => '正文:纯文本',
- 'type' => 'string',
+ 'title' => '自定义输出风格配置',
+ 'description' => '自定义输出风格配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'SummaryImageCount' => ['title' => '摘要-配图数量', 'description' => '摘要-配图数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90'],
+ 'SummaryModel' => ['title' => '摘要模型', 'description' => '摘要模型', 'type' => 'string', 'required' => false, 'example' => '摘要模型'],
+ 'SummaryPrompt' => ['title' => '摘要-自定义Prompt', 'description' => '摘要-自定义Prompt', 'type' => 'string', 'required' => false, 'example' => '摘要-自定义Prompt'],
+ ],
'required' => false,
- 'example' => '杭州亚运会',
],
],
[
- 'name' => 'Uuid',
+ 'name' => 'Size',
'in' => 'formData',
- 'schema' => [
- 'title' => '溯源UUID',
- 'description' => '溯源UUID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '每页大小。最大200', 'description' => '每页大小', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'],
],
[
- 'name' => 'Keywords',
+ 'name' => 'Current',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Locations',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '关键词',
- 'description' => '关键词',
+ 'title' => '新闻地域检索(keyword过滤)',
+ 'description' => '新闻地域检索列表(keyword过滤)',
'type' => 'array',
- 'items' => [
- 'description' => '关键字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关键词',
- ],
+ 'items' => ['description' => '新闻地域检索(keyword过滤)', 'type' => 'string', 'required' => false, 'example' => '重庆'],
'required' => false,
],
],
+ [
+ 'name' => 'LocationQuery',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热点地域的全文检索(该参数存在时current不生效)', 'description' => '热点地域的全文检索(该参数存在时current不生效)', 'type' => 'string', 'required' => false, 'example' => '重庆 成都 浙江 杭州'],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['title' => '全文检索(针对标题、热点摘要、地域的全文检索)(该参数存在时current不生效)', 'description' => '全文检索(针对标题、热点摘要、地域的全文检索)(该参数存在时current不生效)', 'type' => 'string', 'required' => false, 'example' => '重庆新闻'],
+ ],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '42',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'title' => '热点播报单列表信息',
+ 'description' => '热点播报单列表信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '热点信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Category' => ['title' => '热点话题分类', 'description' => '热点话题分类', 'type' => 'string', 'example' => '热点话题分类'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '创建时间'],
+ 'CustomHotValue' => ['title' => '自定义热度值', 'description' => '自定义热度值', 'type' => 'number', 'format' => 'double', 'example' => '34.7905341705522'],
+ 'CustomTextSummary' => ['title' => '自定义热点话题文本摘要', 'description' => '自定义热点话题文本摘要', 'type' => 'string', 'example' => '自定义热点话题文本摘要'],
+ 'HotTopic' => ['title' => '热点话题名称', 'description' => '热点话题名称', 'type' => 'string', 'example' => '热点话题名称'],
+ 'HotTopicVersion' => ['title' => '热点话题摘要版本', 'description' => '热点话题摘要版本', 'type' => 'string', 'example' => '热点话题摘要版本'],
+ 'HotValue' => ['title' => '热度值', 'description' => '热度值', 'type' => 'number', 'format' => 'double', 'example' => '1.4120480606282884'],
+ 'Id' => ['title' => '热点话题ID', 'description' => '热点话题ID', 'type' => 'string', 'example' => '热点话题ID'],
+ 'Images' => [
+ 'title' => '热点话题图片列表',
+ 'description' => '热点话题图片列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '图片对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['description' => 'URL链接', 'type' => 'string', 'example' => 'http://www.example.com/a.png'],
+ ],
+ ],
+ ],
+ 'InputToken' => ['title' => '输入token', 'description' => '输入Token', 'type' => 'integer', 'format' => 'int32', 'example' => '29'],
+ 'News' => [
+ 'title' => '文章列表',
+ 'description' => '文章列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '新闻对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'AnalysisCategory' => ['description' => '模型分类结果', 'type' => 'string', 'example' => '科技'],
+ 'AnalysisTopic' => ['title' => '聚合后热点名称', 'description' => '聚合后热点名称', 'type' => 'string', 'example' => '聚合后热点名称'],
+ 'Author' => ['description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Category' => [
+ 'title' => '分类',
+ 'description' => '分类',
+ 'type' => 'array',
+ 'items' => ['description' => '分类', 'type' => 'string', 'example' => '科技'],
+ ],
+ 'Comments' => [
+ 'title' => '新闻评论',
+ 'description' => '新闻内容',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '评论内容', 'description' => '内容', 'type' => 'string', 'example' => '内容'],
+ 'Username' => ['title' => '评论用户名', 'description' => '用户名', 'type' => 'string', 'example' => '用户名'],
+ ],
+ ],
+ ],
+ 'Content' => ['description' => '新闻内容', 'type' => 'string', 'example' => '新闻内容'."\n"
+ ."\n"],
+ 'CreateTime' => ['description' => '入库时间', 'type' => 'string', 'example' => '2024-06-13 08:45:05'],
+ 'Domain' => ['description' => '来源', 'type' => 'string', 'example' => '夸克'],
+ 'Dt' => ['description' => '入库日期', 'type' => 'string', 'example' => '2024111110'],
+ 'HotTopic' => ['title' => '原始热点名称', 'description' => '原始热点名称', 'type' => 'string', 'example' => '原始热点名称'],
+ 'ImgList' => [
+ 'description' => '图片列表',
+ 'type' => 'array',
+ 'items' => ['description' => '图片URL', 'type' => 'string', 'example' => 'http://www.example.com/a.png'],
+ ],
+ 'Logo' => ['description' => 'logo', 'type' => 'string', 'example' => 'https://www.example.com/a.png'],
+ 'PubTime' => ['description' => '发布时间', 'type' => 'string', 'example' => '2024-10-10 12:12:00'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['description' => '新闻URL', 'type' => 'string', 'example' => 'http://www.example.com/a.png'],
+ 'Uuid' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'string', 'example' => '主键ID'],
+ 'Website' => ['title' => '网站', 'description' => '网站', 'type' => 'string', 'example' => '网站'],
+ ],
+ ],
+ ],
+ 'OutputToken' => ['title' => '输出token', 'description' => '输出Token', 'type' => 'integer', 'format' => 'int32', 'example' => '22'],
+ 'Summary' => [
+ 'title' => '热点话题结构化摘要',
+ 'description' => '热点话题结构化摘要',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputToken' => ['description' => '生成此摘要的输入Token数', 'type' => 'integer', 'format' => 'int32', 'example' => '17'],
+ 'OutputToken' => ['description' => '生成此摘要的输出Token数', 'type' => 'integer', 'format' => 'int32', 'example' => '41'],
+ 'Summaries' => [
+ 'description' => '结构化摘要列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '结构化摘要',
+ 'type' => 'object',
+ 'properties' => [
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'TextSummary' => ['title' => '热点话题文本摘要', 'description' => '热点话题文本摘要', 'type' => 'string', 'example' => '热点话题文本摘要'],
+ 'Locations' => [
+ 'title' => '热点的地域信息',
+ 'description' => '热点的地域信息列表',
+ 'type' => 'array',
+ 'items' => ['title' => '地域信息', 'description' => '热点的地域信息', 'type' => 'string', 'example' => '成都'],
+ ],
+ 'Url' => ['title' => '热榜URL', 'description' => '热榜URL', 'type' => 'string', 'example' => 'http://www.example.com/a.html'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2025-08-01 12:00:00'],
+ ],
+ ],
+ ],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'TotalTokenInfo' => [
+ 'title' => '全部生成预计所需要的Token数',
+ 'description' => '全部生成预计所需要的Token数',
+ 'type' => 'object',
+ 'properties' => [
+ 'HotTopicCount' => ['title' => '热点总数', 'description' => '热点总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'InputTokens' => ['title' => '预计输入token数', 'description' => '预计输入Token数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'OutputTokens' => ['title' => '预计输出token数', 'description' => '预计输出Token数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'WordCount' => ['title' => '预计总字数', 'description' => '预计总字数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ ],
+ ],
],
+ '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'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": 42,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => '保存文档',
- ],
- 'DeleteGeneratedContent' => [
- 'summary' => '删除文档:用来删除妙笔中创作的文章。',
- 'methods' => [
- 'post',
+ 'title' => '查询完整播报单(热榜)',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-09T11:39:29.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-31T12:47:20.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-31T05:13:53.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetHotTopicBroadcast',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"Category\\": \\"热点话题分类\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CustomHotValue\\": 34.7905341705522,\\n \\"CustomTextSummary\\": \\"自定义热点话题文本摘要\\",\\n \\"HotTopic\\": \\"热点话题名称\\",\\n \\"HotTopicVersion\\": \\"热点话题摘要版本\\",\\n \\"HotValue\\": 1.4120480606282884,\\n \\"Id\\": \\"热点话题ID\\",\\n \\"Images\\": [\\n {\\n \\"Url\\": \\"http://www.example.com/a.png\\"\\n }\\n ],\\n \\"InputToken\\": 29,\\n \\"News\\": [\\n {\\n \\"AnalysisCategory\\": \\"科技\\",\\n \\"AnalysisTopic\\": \\"聚合后热点名称\\",\\n \\"Author\\": \\"作者\\",\\n \\"Category\\": [\\n \\"科技\\"\\n ],\\n \\"Comments\\": [\\n {\\n \\"Text\\": \\"内容\\",\\n \\"Username\\": \\"用户名\\"\\n }\\n ],\\n \\"Content\\": \\"新闻内容\\\\n\\\\n\\",\\n \\"CreateTime\\": \\"2024-06-13 08:45:05\\",\\n \\"Domain\\": \\"夸克\\",\\n \\"Dt\\": \\"2024111110\\",\\n \\"HotTopic\\": \\"原始热点名称\\",\\n \\"ImgList\\": [\\n \\"http://www.example.com/a.png\\"\\n ],\\n \\"Logo\\": \\"https://www.example.com/a.png\\",\\n \\"PubTime\\": \\"2024-10-10 12:12:00\\",\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com/a.png\\",\\n \\"Uuid\\": \\"主键ID\\",\\n \\"Website\\": \\"网站\\"\\n }\\n ],\\n \\"OutputToken\\": 22,\\n \\"Summary\\": {\\n \\"InputToken\\": 17,\\n \\"OutputToken\\": 41,\\n \\"Summaries\\": [\\n {\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ]\\n },\\n \\"TextSummary\\": \\"热点话题文本摘要\\",\\n \\"Locations\\": [\\n \\"成都\\"\\n ],\\n \\"Url\\": \\"http://www.example.com/a.html\\",\\n \\"PubTime\\": \\"2025-08-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"TotalTokenInfo\\": {\\n \\"HotTopicCount\\": 100,\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"WordCount\\": 100\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetInterveneGlobalReply' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '99',
- ],
- ],
- [
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'PlainResult<GetGlobalReplyResult>',
+ 'description' => 'PlainResult<GetGlobalReplyResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'type' => 'object',
+ 'properties' => [
+ 'ReplyMessagList' => [
+ 'title' => '回复信息列表',
+ 'description' => '回复信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '回复内容', 'description' => '回复内容', 'type' => 'string', 'example' => 'success'],
+ 'ReplyType' => [
+ 'title' => '回复类型',
+ 'description' => '回复类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)', 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)', 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)'],
+ 'example' => 'namespace_qa_query',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得干预全局回复内容',
+ 'summary' => '获得干预全局回复。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除文档',
- ],
- 'UpdateGeneratedContent' => [
- 'summary' => '更新文档:用来更新妙笔中创作的文章历史。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneGlobalReply',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"ReplyMessagList\\": [\\n {\\n \\"Message\\": \\"success\\",\\n \\"ReplyType\\": \\"namespace_qa_query\\"\\n }\\n ],\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetInterveneImportTaskInfo' => [
+ 'summary' => '获得导入任务信息。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public'],
],
[
- 'name' => 'Id',
+ 'name' => 'TaskId',
'in' => 'formData',
+ 'schema' => ['title' => '任务id', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '19162157'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '36',
+ 'title' => 'PlainResult<GetImportTaskInfoResult>',
+ 'description' => 'PlainResult<GetImportTaskInfoResult>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => [
+ 'title' => '任务状态信息',
+ 'description' => '任务状态信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Msg' => ['title' => '任务信息', 'description' => '任务信息', 'type' => 'string', 'example' => 'success'],
+ 'Percentage' => ['title' => '完成百分比', 'description' => '完成百分比', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
+ 'Status' => [
+ 'title' => '任务状态',
+ 'description' => '任务状态',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => ['3-超时' => '3-超时', '2-错误' => '2-错误', ' 1-进行中 ' => ' 1-进行中 ', '0-结束' => '0-结束'],
+ 'example' => '0',
+ ],
+ 'TaskId' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => '41405255'],
+ 'TaskName' => ['title' => '任务名字', 'description' => '任务名字', 'type' => 'string', 'example' => 'ft-task-20190101m8rnK'],
+ ],
+ ],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ ],
+ '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'],
+ ],
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得干预项目导入任务信息',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '最后一次生成的提示词',
- 'description' => '最后一次生成的提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '创作xx文章',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneImportTaskInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"Status\\": {\\n \\"Msg\\": \\"success\\",\\n \\"Percentage\\": 80,\\n \\"Status\\": 0,\\n \\"TaskId\\": \\"41405255\\",\\n \\"TaskName\\": \\"ft-task-20190101m8rnK\\"\\n },\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetInterveneRuleDetail' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章名称',
- 'maxLength' => 200,
- 'minLength' => 2,
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '正文:富文本',
- 'description' => '正文:富文本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '正文',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm'],
],
[
- 'name' => 'ContentText',
+ 'name' => 'RuleId',
'in' => 'formData',
+ 'schema' => ['title' => '规则id', 'description' => '规则id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '正文:纯文本',
- 'description' => '正文:纯文本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '正文',
+ 'title' => 'PlainResult<GetInterveneRuleDetailResult>',
+ 'description' => 'PlainResult<GetInterveneRuleDetailResult>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'InterveneRuleDetail' => [
+ 'title' => '规则详情结构',
+ 'description' => '规则详情结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'AnswerConfig' => [
+ 'title' => '答案信息配置',
+ 'description' => '答案信息配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AnswerType' => [
+ 'title' => '答案类型',
+ 'description' => '答案类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => ['0-统一回复' => '0-统一回复', '1-定向回复 ' => '1-定向回复 '],
+ 'example' => '0',
+ ],
+ 'Message' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'example' => '早上好'],
+ 'Namespace' => [
+ 'title' => '命名空间',
+ 'description' => '命名空间',
+ 'type' => 'string',
+ 'enumValueTitles' => [' namespace_writing_query (写作输入干预)' => ' namespace_writing_query (写作输入干预)', ' namespace_qa_result (问答结果干预)' => ' namespace_qa_result (问答结果干预)', 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', ' namespace_writing_result (写作结果干预)' => ' namespace_writing_result (写作结果干预)'],
+ 'example' => 'namespace_qa_query',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'EffectConfig' => [
+ 'title' => '生效配置',
+ 'description' => '生效配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'EffectType' => [
+ 'title' => '生效类型',
+ 'description' => '生效类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => ['0-永久生效 ' => '0-永久生效 ', '1-按时间生效' => '1-按时间生效'],
+ 'example' => '0',
+ ],
+ 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'example' => '2023-11-25 14:21:15'],
+ 'StartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'example' => '2023-11-25 14:21:15'],
+ ],
+ ],
+ 'InterveneType' => [
+ 'title' => '干预类型',
+ 'description' => '干预类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => ['3-关键词库干预项 ' => '3-关键词库干预项 ', '0-相似问干预项目 ' => '0-相似问干预项目 ', ' 2-正则表达式干预项 ' => ' 2-正则表达式干预项 ', '4-URL干预' => '4-URL干预', '1-关键词表达式干预项' => '1-关键词表达式干预项'],
+ 'example' => '0',
+ ],
+ 'NamespaceList' => [
+ 'title' => '命名空间列表',
+ 'description' => '命名空间列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '干预维度',
+ 'type' => 'string',
+ 'enumValueTitles' => ['namespace_writing_image (智能配图)' => 'namespace_writing_image (智能配图)', 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', 'namespace_qa_article (问答参考)' => 'namespace_qa_article (问答参考)', 'namespace_writing_article (写作参考)' => 'namespace_writing_article (写作参考)', 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)', 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)', 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)'],
+ 'example' => 'namespace_qa_query',
+ ],
+ ],
+ 'RuleId' => ['title' => '规则id', 'description' => '规则id', 'type' => 'integer', 'format' => 'int64', 'example' => '100418'],
+ 'RuleName' => ['title' => '规则名字', 'description' => '规则名字', 'type' => 'string', 'example' => '规则001'],
+ ],
+ ],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
+ ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得干预规则的详情',
+ 'summary' => '获得干预项规则详情。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Keywords',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '关键词',
- 'description' => '关键词',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '登机',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneRuleDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"InterveneRuleDetail\\": {\\n \\"AnswerConfig\\": [\\n {\\n \\"AnswerType\\": 0,\\n \\"Message\\": \\"早上好\\",\\n \\"Namespace\\": \\"namespace_qa_query\\"\\n }\\n ],\\n \\"EffectConfig\\": {\\n \\"EffectType\\": 0,\\n \\"EndTime\\": \\"2023-11-25 14:21:15\\",\\n \\"StartTime\\": \\"2023-11-25 14:21:15\\"\\n },\\n \\"InterveneType\\": 0,\\n \\"NamespaceList\\": [\\n \\"namespace_qa_query\\"\\n ],\\n \\"RuleId\\": 100418,\\n \\"RuleName\\": \\"规则001\\"\\n },\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetInterveneTemplateFileUrl' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'PlainResult<GetTemplateFileUrlResult>',
+ 'description' => 'PlainResult<GetTemplateFileUrlResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- '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',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileUrl' => ['title' => '模版文件地址', 'description' => '模版文件地址', 'type' => 'string', 'example' => 'http://xxx/xxx.xls'],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得干预导入模版文件地址',
+ 'summary' => '获得干预导入模版文件下载地址。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '更新文档',
- ],
- 'GetGeneratedContent' => [
- 'summary' => '获取文档:用来查询妙笔中创作的文章历史。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneTemplateFileUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://xxx/xxx.xls\\",\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetMaterialById' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -14507,202 +9343,106 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public'],
],
[
'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '任务主键ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '60'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'PlainResult<MaterialDocumentDO>',
+ 'description' => 'PlainResult<MaterialDocumentDO>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'title' => '正文:富文本',
- 'description' => '正文:富文本',
- 'type' => 'string',
- 'example' => '杭州亚运会',
- ],
- 'ContentDomain' => [
- 'title' => '内容生成的领域-media:新闻、government:政务',
- 'description' => '内容生成的领域-media:新闻、government:政务',
- 'type' => 'string',
- 'example' => 'media',
- ],
- 'ContentText' => [
- 'title' => '正文:纯文本',
- 'description' => '正文:纯文本',
- 'type' => 'string',
- 'example' => '杭州亚运会',
- ],
- 'CreateTime' => [
- 'title' => '创建日期',
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => '"1"',
- ],
- 'DeviceId' => [
- 'title' => '设备ID',
- 'description' => '设备ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Id' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '86',
- ],
- 'KeywordList' => [
- 'title' => '关键词',
- 'description' => '关键词',
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '文档作者'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-03-21 11:34:19'],
+ 'CreateUser' => ['title' => '创建用户ID', 'description' => '创建用户ID', 'type' => 'string', 'example' => '1'],
+ 'DocKeywords' => [
+ 'title' => '文档标签用于分类等、不同keyword之间逗号分割',
+ 'description' => '文档标签用于分类等、不同keyword之间逗号分割',
'type' => 'array',
- 'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'example' => '观点',
- ],
- ],
- 'Keywords' => [
- 'title' => '关键词(string)',
- 'description' => '关键词(string)',
- 'type' => 'string',
- 'example' => '[\\"教师\\",\\"乡村\\"]',
- ],
- 'Prompt' => [
- 'title' => '最后一次生成的提示词',
- 'description' => '最后一次生成的提示词',
- 'type' => 'string',
- 'example' => '创作xxx文章',
- ],
- 'TaskId' => [
- 'title' => '会话任务唯一标识',
- 'description' => '会话任务唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '杭州亚运会',
- ],
- 'UpdateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'UpdateUser' => [
- 'title' => '更新者',
- 'description' => '更新者',
- 'type' => 'string',
- 'example' => '"1"',
- ],
- 'Uuid' => [
- 'title' => 'UUID 溯源唯一标识',
- 'description' => 'UUID 溯源唯一标识',
- 'type' => 'string',
- 'example' => '0961a514-2e26-4aa6-b22b-f592d145fe47',
- ],
- 'IgnoreContentAuditWords' => [
- 'title' => '审核忽略的单词对象列表',
- 'description' => '审核忽略的单词对象列表(json字符串)',
- 'type' => 'string',
- 'example' => '"[{}]"',
+ 'items' => ['description' => '关键词', 'type' => 'string', 'example' => '关键词'],
+ ],
+ 'DocType' => ['title' => '文档类型,pdf、word、url、image', 'description' => '文档类型,pdf、word、url、image', 'type' => 'string', 'example' => 'pdf'],
+ 'ExternalUrl' => ['title' => '外部客户上传的URL,仅用作记录保存', 'description' => '外部客户上传的URL,仅用作记录保存', 'type' => 'string', 'example' => 'https://www.example.com'."\n"],
+ 'HtmlContent' => ['description' => '网页内容', 'type' => 'string', 'example' => '网页内容'],
+ 'Id' => ['title' => '主键', 'description' => '主键', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2023-04-11 06:14:07'."\n"],
+ 'PublicUrl' => ['title' => '临时的对外公开的URL', 'description' => '临时的对外公开的URL', 'type' => 'string', 'example' => 'https://www.example.com'."\n"],
+ 'ShareAttr' => [
+ 'title' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
+ 'description' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'enum' => ['0', '1'],
],
+ 'SrcFrom' => ['title' => '文档来源,user_upload、search、viewpoint', 'description' => '文档来源,user_upload、search、viewpoint', 'type' => 'string', 'example' => 'user_upload'],
+ 'Summary' => ['title' => '文档摘要', 'description' => '文档摘要', 'type' => 'string', 'example' => '文档摘要'],
+ 'TextContent' => ['title' => '解析后的文本内容,对于图片来说为空', 'description' => '解析后的文本内容,对于图片来说为空', 'type' => 'string', 'example' => '文本内容'],
+ 'ThumbnailInBase64' => ['title' => '图片文档类型的Base64缩略图', 'description' => '图片文档类型的Base64缩略图', 'type' => 'string', 'example' => 'Base64编码的缩略图'],
+ 'Title' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'example' => '文档标题'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2022-04-08 19:33:01'],
+ 'UpdateUser' => ['title' => '修改用户ID', 'description' => '修改用户ID', 'type' => 'string', 'example' => '1'],
+ 'Url' => ['title' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除', 'description' => '内部文档保存的URL', 'type' => 'string', 'example' => 'https://www.example.com'],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取素材',
+ 'summary' => '获取素材:获取素材库中素材详细信息。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Content\\": \\"杭州亚运会\\",\\n \\"ContentDomain\\": \\"media\\",\\n \\"ContentText\\": \\"杭州亚运会\\",\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"CreateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"DeviceId\\": \\"xxx\\",\\n \\"Id\\": 86,\\n \\"KeywordList\\": [\\n \\"观点\\"\\n ],\\n \\"Keywords\\": \\"[\\\\\\\\\\\\\\"教师\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"乡村\\\\\\\\\\\\\\"]\\",\\n \\"Prompt\\": \\"创作xxx文章\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Title\\": \\"杭州亚运会\\",\\n \\"UpdateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"UpdateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"Uuid\\": \\"0961a514-2e26-4aa6-b22b-f592d145fe47\\",\\n \\"IgnoreContentAuditWords\\": \\"\\\\\\"[{}]\\\\\\"\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取文档',
- ],
- 'ListGeneratedContents' => [
- 'summary' => '获取文档列表:用来查询妙笔中创作的文章历史列表。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMaterialById'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetMaterialById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": {\\n \\"Author\\": \\"文档作者\\",\\n \\"CreateTime\\": \\"2023-03-21 11:34:19\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"DocKeywords\\": [\\n \\"关键词\\"\\n ],\\n \\"DocType\\": \\"pdf\\",\\n \\"ExternalUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"HtmlContent\\": \\"网页内容\\",\\n \\"Id\\": 32,\\n \\"PubTime\\": \\"2023-04-11 06:14:07\\\\n\\",\\n \\"PublicUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"ShareAttr\\": 1,\\n \\"SrcFrom\\": \\"user_upload\\",\\n \\"Summary\\": \\"文档摘要\\",\\n \\"TextContent\\": \\"文本内容\\",\\n \\"ThumbnailInBase64\\": \\"Base64编码的缩略图\\",\\n \\"Title\\": \\"文档标题\\",\\n \\"UpdateTime\\": \\"2022-04-08 19:33:01\\",\\n \\"UpdateUser\\": \\"1\\",\\n \\"Url\\": \\"https://www.example.com\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ ],
+ 'GetPptArtifact' => [
+ 'summary' => '查询PPT作品信息。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -14710,370 +9450,173 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'TaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务标识',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task-03d46184ee7d8749',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglxxxx'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'PptArtifactId',
'in' => 'formData',
- 'schema' => [
- 'description' => '开始时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-04 11:46:07',
- ],
+ 'schema' => ['title' => '作品ID', 'description' => 'PPT作品ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5232136'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'description' => '结束时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-04 11:46:07',
- ],
+ 'schema' => ['title' => '第三方传入的用户ID', 'type' => 'string', 'example' => 'abc'],
],
- [
- 'name' => 'Title',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '标题:支持模糊搜索',
- '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2024-11-25 11:40:50'],
+ 'Id' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '内容标题'."\n"
+ ."\n"],
+ 'UpdateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2024-11-25 11:40:50'],
+ 'FileKey' => ['description' => '后端业务存储本次规则库解析结果的路径。', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
+ 'FileAttr' => [
+ 'description' => '文件属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileName' => ['description' => '文件名称', 'type' => 'string', 'example' => 'xxx.pptx'],
+ 'Width' => ['description' => '宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '800'],
+ 'TmpUrl' => ['description' => '视频文件临时访问URL。1小时过期', 'type' => 'string', 'example' => 'http://www.example.com/xxx.pptx'],
+ 'Height' => ['description' => '高度', 'type' => 'integer', 'format' => 'int32', 'example' => '600'],
+ ],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询PPT作品信息',
+ 'description' => '接入说明:'."\n"
+ ."\n"
+ .'- 当前接口为 HTTP-SSE 协议。'."\n"
+ .'- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持Java、Python版本的 sdk)请参考[PPT生成最佳实践文档](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices)。'."\n"
+ .'- 其中获取 Java 异步 SDK 的最新版本: [请点击链接获取](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?spm=a2c4g.11186623.0.0.4cd3170d7rccDC&version=2023-08-01&language=java-async-tea&tab=primer-doc)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '搜索关键词:支持标题和正文模糊搜索',
- 'description' => '搜索关键词:支持标题和正文模糊搜索',
- 'type' => 'string',
- 'required' => false,
- 'example' => '检索Query',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"CreateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"Id\\": 10,\\n \\"Title\\": \\"内容标题\\\\n\\\\n\\",\\n \\"UpdateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"xxx.pptx\\",\\n \\"Width\\": 800,\\n \\"TmpUrl\\": \\"http://www.example.com/xxx.pptx\\",\\n \\"Height\\": 600\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'GetPptArtifactExportResult' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ContentDomain',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '内容领域(创作类型的分类)'."\n"
- .' - media: 传媒写作'."\n"
- .'- government: 政府公文写作'."\n"
- .'- office:办公写作'."\n"
- .'- market:营销写作'."\n"
- .'- custom: 自定义写作'."\n"
- .'- commentGenerate: 观点生成',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'market' => '营销写作',
- 'government' => '政务',
- 'custom' => '自定义写作',
- 'media' => '传媒',
- 'office' => '办公写作',
- 'commentGenerate' => '观点生成',
- ],
- 'example' => 'media',
- 'default' => 'media',
- 'enum' => [],
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
[
- 'name' => 'Current',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxx'],
],
[
- 'name' => 'Size',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
+ 'schema' => ['type' => 'string', 'example' => 'abc'],
],
[
- 'name' => 'DataType',
+ 'name' => 'ExportTaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '数据类型筛选'."\n"
- ."\n"
- .'- plainText:纯文本'."\n"
- .'- richText:富文本'."\n"
- .'- html:网页'."\n"
- .'- pdf:PDF'."\n"
- .'- word:WORD'."\n"
- .'- excel:excel'."\n"
- .'- csv:CSV'."\n"
- .'- image:图片'."\n"
- .'- video:视频'."\n"
- .'- audio:音频',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'plainText',
- ],
+ 'schema' => ['title' => '导出任务的Key', 'description' => '导出任务的Key', 'type' => 'string', 'required' => false, 'example' => '15aeb61b-cdeb-4b70-94d7-99518040647e'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Current' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'description' => '文档列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '正文:富文本',
- 'description' => '正文:富文本',
- 'type' => 'string',
- 'example' => '杭州亚运会',
- ],
- 'ContentDomain' => [
- 'title' => '内容生成的领域-media:新闻、government:政务',
- 'description' => '内容领域(创作类型的分类)'."\n"
- .' - media: 传媒写作'."\n"
- .'- government: 政府公文写作'."\n"
- .'- office:办公写作'."\n"
- .'- market:营销写作'."\n"
- .'- custom: 自定义写作'."\n"
- .'- commentGenerate: 观点生成',
- 'type' => 'string',
- 'example' => 'media',
- ],
- 'ContentText' => [
- 'title' => '正文:纯文本',
- 'description' => '正文:纯文本',
- 'type' => 'string',
- 'example' => '杭州亚运会',
- ],
- 'CreateTime' => [
- 'title' => '创建日期',
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => '"123"',
- ],
- 'DeviceId' => [
- 'title' => '设备ID',
- 'description' => '设备ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Id' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'KeywordList' => [
- 'title' => '关键词',
- 'description' => '关键词',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'example' => '观点',
- ],
- ],
- 'Keywords' => [
- 'title' => '关键词(string)',
- 'description' => '关键词(string)',
- 'type' => 'string',
- 'example' => '观点',
- ],
- 'Prompt' => [
- 'title' => '最后一次生成的提示词',
- 'description' => '最后一次生成的提示词',
- 'type' => 'string',
- 'example' => '创作xxx文章',
- ],
- 'TaskId' => [
- 'title' => '会话任务唯一标识',
- 'description' => '会话任务唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '杭州亚运会',
- ],
- 'UpdateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'UpdateUser' => [
- 'title' => '更新者',
- 'description' => '更新者',
- 'type' => 'string',
- 'example' => '"1111"',
- ],
- 'Uuid' => [
- 'title' => 'UUID 溯源唯一标识',
- 'description' => 'UUID 溯源唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'FileKey' => [
- 'description' => '文件唯一标识',
- 'type' => 'string',
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
- 'FileAttr' => [
- 'description' => '文件属性',
- 'type' => 'object',
- 'properties' => [
- 'FileName' => [
- 'description' => '文件名称',
- 'type' => 'string',
- 'example' => 'homedepothp.txt',
- ],
- 'Width' => [
- 'description' => '视频宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '800',
- ],
- 'TmpUrl' => [
- 'description' => '视频文件临时访问URL。1小时过期',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.mp4',
- ],
- 'Height' => [
- 'description' => '视频高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- ],
- ],
- ],
+ 'title' => '',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'ExportFileLink' => [
+ 'title' => '导出任务的Key',
+ 'description' => '导出任务的Key',
+ 'type' => 'array',
+ 'items' => ['description' => '文件链接', 'type' => 'string', 'example' => 'http://xxx.com/a.png'],
],
],
],
- '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',
- ],
- 'Size' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询PPT导出任务的结果',
+ 'summary' => '查询PPT导出任务的结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Content\\": \\"杭州亚运会\\",\\n \\"ContentDomain\\": \\"media\\",\\n \\"ContentText\\": \\"杭州亚运会\\",\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"CreateUser\\": \\"\\\\\\"123\\\\\\"\\",\\n \\"DeviceId\\": \\"xxx\\",\\n \\"Id\\": 10,\\n \\"KeywordList\\": [\\n \\"观点\\"\\n ],\\n \\"Keywords\\": \\"观点\\",\\n \\"Prompt\\": \\"创作xxx文章\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Title\\": \\"杭州亚运会\\",\\n \\"UpdateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"UpdateUser\\": \\"\\\\\\"1111\\\\\\"\\",\\n \\"Uuid\\": \\"xxx\\",\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"homedepothp.txt\\",\\n \\"Width\\": 800,\\n \\"TmpUrl\\": \\"http://www.example.com/xxx.mp4\\",\\n \\"Height\\": 500\\n }\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
- 'title' => '获取文档列表',
- ],
- 'ExportGeneratedContent' => [
- 'summary' => '导出文档:用来导出妙笔中创作的文章历史。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptArtifactExportResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"ExportFileLink\\": [\\n \\"http://xxx.com/a.png\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetPptConfig' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -15081,1737 +9624,2081 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq'],
],
[
- 'name' => 'Id',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['type' => 'string', 'example' => 'abc'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'title' => '业务数据',
+ 'title' => '',
'description' => '业务数据',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- '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',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppKey' => ['title' => 'AppKey', 'description' => 'AppKey', 'type' => 'string', 'example' => '333444766'],
+ 'Code' => ['title' => 'Code', 'description' => 'Code', 'type' => 'string', 'example' => 'r4wr5y6g'],
+ ],
],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"xxx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '导出文档',
- ],
- 'SaveMaterialDocument' => [
- 'summary' => '保存素材:保存素材库中素材。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取PPT组件配置',
+ 'summary' => '获取PPT组件配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"AppKey\\": \\"333444766\\",\\n \\"Code\\": \\"r4wr5y6g\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetPptInfo' => [
+ 'summary' => '查询PPT任务信息',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-2setzb9xb8mx6vss'],
],
[
- 'name' => 'DocType',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'description' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'excel',
- 'enum' => [
- 'html',
- 'plainText',
- 'image',
- 'pdf',
- 'word',
- 'excel',
- 'csv',
- 'jsonLine',
- ],
- ],
+ 'schema' => ['title' => '第三方传入的用户ID', 'type' => 'string', 'example' => 'abc'],
],
[
- 'name' => 'Title',
+ 'name' => 'TaskId',
'in' => 'formData',
+ 'schema' => ['title' => 'PPT任务的ID', 'description' => 'PPT任务的ID', 'type' => 'string', 'required' => false, 'example' => '1f178f22-ec52-467d-8489-eef4468x0240'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '文档标题',
- '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => 'PPT任务的ID', 'description' => 'PPT任务的ID', 'type' => 'string', 'example' => 'xxx-xxx-xx'],
+ 'Query' => ['title' => 'PPT任务的输入信息', 'description' => 'PPT任务的输入信息', 'type' => 'string', 'example' => '关于班会主题的PPT'],
+ 'PptProcessId' => ['title' => 'PPT流程ID', 'description' => 'PPT流程ID', 'type' => 'string', 'example' => '11231232'],
+ 'PptArtifactId' => ['title' => 'PPT作品ID', 'description' => 'PPT作品ID', 'type' => 'string', 'example' => '5423431'],
+ 'PptArtifactCover' => ['title' => '封面图', 'type' => 'string', 'example' => 'http://a.com/xxx.jpeg'],
+ 'ExportTaskId' => ['title' => '导出任务的key', 'description' => '导出任务的key', 'type' => 'string', 'example' => 'xxx-xxx-xx'],
+ 'ExportFileLink' => [
+ 'title' => '导出文件链接',
+ 'description' => '导出文件链接',
+ 'type' => 'array',
+ 'items' => ['description' => '文件链接', 'type' => 'string', 'example' => 'http://xxx.com/a.pptx'],
+ ],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询PPT任务信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Author',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'required' => false,
- 'example' => '作者名称',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxx-xxx-xx\\",\\n \\"Query\\": \\"关于班会主题的PPT\\",\\n \\"PptProcessId\\": \\"11231232\\",\\n \\"PptArtifactId\\": \\"5423431\\",\\n \\"PptArtifactCover\\": \\"http://a.com/xxx.jpeg\\",\\n \\"ExportTaskId\\": \\"xxx-xxx-xx\\",\\n \\"ExportFileLink\\": [\\n \\"http://xxx.com/a.pptx\\"\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetPptTemplateSelector' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PubTime',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-04-11 06:14:07',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
- 'name' => 'DocKeywords',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'lm-xxxx'],
+ ],
+ ],
+ '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' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '响应对象',
+ 'description' => '响应对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Colour' => [
+ 'title' => '颜色',
+ 'description' => '颜色',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '颜色ID', 'description' => '颜色ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Name' => ['title' => '颜色名称', 'description' => '颜色名称', 'type' => 'string', 'example' => '橙色'],
+ 'Code' => ['title' => '颜色值', 'description' => '颜色值', 'type' => 'string', 'example' => '#FCC462'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'SuitStyle' => [
+ 'title' => '风格',
+ 'description' => '风格',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '风格ID', 'description' => '风格ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Title' => ['title' => '风格名称', 'description' => '风格名称', 'type' => 'string', 'example' => '扁平简约'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'SuitScene' => [
+ 'title' => '场景',
+ 'description' => '场景',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '场景ID', 'description' => '场景ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Title' => ['title' => '场景名称', 'description' => '场景名称', 'type' => 'string', 'example' => '教育培训'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Career' => [
+ 'title' => '职业',
+ 'description' => '职业',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '职业ID', 'description' => '职业ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Name' => ['title' => '职业名称', 'description' => '职业名称', 'type' => 'string', 'example' => '教育培训'],
+ 'IsHot' => ['title' => '高热度', 'description' => '高热度', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
],
- 'required' => false,
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询PPT模板筛选器',
+ 'summary' => '查询PPT模板筛选器',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Url',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '素材的URL',
- 'description' => '素材的URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxxx/xxx',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptTemplateSelector',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"Colour\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"橙色\\",\\n \\"Code\\": \\"#FCC462\\"\\n }\\n ],\\n \\"SuitStyle\\": [\\n {\\n \\"Id\\": 1,\\n \\"Title\\": \\"扁平简约\\"\\n }\\n ],\\n \\"SuitScene\\": [\\n {\\n \\"Id\\": 1,\\n \\"Title\\": \\"教育培训\\"\\n }\\n ],\\n \\"Career\\": [\\n {\\n \\"Id\\": 1,\\n \\"Name\\": \\"教育培训\\",\\n \\"IsHot\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'GetProperties' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'ExternalUrl',
- 'in' => 'formData',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxx_efm'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '外部客户上传的URL,仅用作记录保存',
- 'description' => '外部客户上传的URL,仅用作记录保存',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxxx/xxx'."\n",
+ 'title' => 'PlainResult<TongYiLlmPropertiesDO>',
+ 'description' => 'PlainResult<TongYiLlmPropertiesDO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'ChatConfig' => ['title' => '通话配置', 'description' => '通话配置', 'type' => 'object'],
+ 'ConsoleConfig' => [
+ 'title' => '控制台配置',
+ 'description' => '控制台配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'TipContent' => ['title' => '提示内容', 'description' => '提示内容', 'type' => 'string', 'example' => 'xx'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'AI妙笔'],
+ ],
+ ],
+ 'GeneralConfigMap' => ['title' => '通用配置表', 'description' => '通用配置表', 'type' => 'object'],
+ 'IntelligentSearchConfig' => [
+ 'title' => '智搜配置',
+ 'description' => '智搜配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProductDescription' => ['title' => '首页产品描述', 'description' => '首页产品描述', 'type' => 'string', 'example' => 'xxx'],
+ 'SearchSamples' => [
+ 'title' => '智搜推荐',
+ 'description' => '智搜推荐',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'sample',
+ 'type' => 'object',
+ 'properties' => [
+ 'Articles' => [
+ 'title' => '文章列表',
+ 'description' => '文章列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章',
+ 'type' => 'object',
+ 'properties' => [
+ 'Select' => ['title' => '前端传递时是否手动选择', 'description' => '前端传递时是否手动选择', 'type' => 'boolean', 'example' => 'true'],
+ 'Stared' => ['title' => '是否为星标文章', 'description' => '是否为星标文章', 'type' => 'boolean', 'example' => 'false'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'http://xxx.com'],
+ ],
+ ],
+ ],
+ 'Prompt' => ['title' => '提示词', 'description' => '提示词', 'type' => 'string', 'example' => 'xx'],
+ 'Text' => ['title' => '生成内容', 'description' => '生成内容', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ ],
+ ],
+ 'SearchSources' => [
+ 'title' => '搜索源列表',
+ 'description' => '搜索源列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '搜索源',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '数据集唯一标识: code+datasetName', 'description' => '数据集唯一标识: code+datasetName', 'type' => 'string', 'example' => 'xx'],
+ 'DatasetName' => ['title' => '数据集唯一标识: code+datasetName', 'description' => '数据集唯一标识: code+datasetName', 'type' => 'string', 'example' => 'xx'],
+ 'Name' => ['title' => '搜索源名称:中文', 'description' => '搜索源名称:中文', 'type' => 'string', 'example' => 'xx'],
+ ],
+ ],
+ ],
+ 'CopilotPreciseSearchSources' => [
+ 'title' => '妙搜:搜索源配置',
+ 'description' => '妙搜:搜索源配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '数据集唯一标识: code+datasetName', 'description' => '数据集唯一标识: code+datasetName', 'type' => 'string', 'example' => 'x'],
+ 'DatasetName' => ['title' => '数据集唯一标识: code+datasetName', 'description' => '数据集唯一标识: code+datasetName', 'type' => 'string', 'example' => 'x'],
+ 'Name' => ['title' => '搜索源名称:中文', 'description' => '搜索源名称:中文', 'type' => 'string', 'example' => 'x'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'SearchSources' => [
+ 'title' => '搜索源',
+ 'description' => '搜索源下拉列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '搜索源',
+ 'type' => 'object',
+ 'properties' => [
+ 'Label' => ['title' => '下拉列表的展示值', 'description' => '搜索源名称', 'type' => 'string', 'example' => '夸克通用搜索'],
+ 'Value' => ['title' => '下拉列表的传递值', 'description' => '搜索源code', 'type' => 'string', 'example' => 'SystemSearch'],
+ ],
+ ],
+ ],
+ 'SlrAuthorized' => ['title' => 'SLR 是否已经授权', 'description' => 'SLR 是否已经授权', 'type' => 'boolean', 'example' => 'true'],
+ 'UserInfo' => [
+ 'title' => '用户配置',
+ 'description' => '用户配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'AgentId' => ['title' => '业务空间唯一标识', 'description' => '业务空间唯一标识', 'type' => 'string', 'example' => '1'],
+ 'TenantId' => ['title' => '租户唯一标识', 'description' => '租户唯一标识', 'type' => 'string', 'example' => '1'],
+ 'UserId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '1'],
+ 'Username' => ['title' => '用户名称', 'description' => '用户名称', 'type' => 'string', 'example' => 'admin'],
+ ],
+ ],
+ 'WanxiangImageSizeConfig' => [
+ 'title' => '万相图片尺寸',
+ 'description' => '万相图片',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '万相图片尺寸',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '图片尺寸比例', 'description' => '图片尺寸比例', 'type' => 'string', 'example' => '1:1'],
+ 'Value' => ['title' => '图片尺寸像素', 'description' => '图片尺寸像素', 'type' => 'string', 'example' => '1024*1024'],
+ ],
+ ],
+ ],
+ 'WanxiangImageStyleConfig' => [
+ 'title' => '万相图片风格配置',
+ 'description' => '万相图片风格配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '风格名称', 'description' => '风格名称', 'type' => 'string', 'example' => '默认'],
+ 'Pic' => ['title' => '风格图片地址', 'description' => '风格图片地址', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png'],
+ 'Value' => ['title' => '风格code', 'description' => '风格code', 'type' => 'string', 'example' => '<auto>'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'SearchSourceList' => [
+ 'description' => '指定的搜索源列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '搜索源类型:对应(SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索)', 'description' => '搜索源类型:对应(SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索)', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'Name' => ['title' => '搜索源描述', 'description' => '搜索源描述', 'type' => 'string', 'example' => '互联网检索'],
+ 'DatasetName' => ['title' => '数据源唯一标识', 'description' => '数据源唯一标识', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'MiaosouConfig' => [
+ 'title' => '妙搜配置',
+ 'description' => '妙搜配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'UseDocSize' => ['title' => '数据集已使用文档数', 'description' => '数据集已使用文档数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'MaxDocSize' => ['title' => '数据集可用文档数', 'description' => '数据集可用文档数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'ModelInfos' => [
+ 'title' => '智能搜索支持的模型列表',
+ 'description' => '智能搜索支持的模型列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '智能搜索支持的模型',
+ 'description' => '智能搜索支持的模型',
+ 'type' => 'object',
+ 'properties' => [
+ 'ModelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '全妙-Max'],
+ 'ModelId' => ['title' => '模型id', 'description' => '模型id', 'type' => 'string', 'example' => 'quanmiao-max'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取配置信息',
+ 'summary' => '获取配置信息。包括不限于智能配置的风格,推理相关元数据配置等。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-05T11:27:42.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-12T11:49:50.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-05-08T06:40:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetProperties'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SrcFrom',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
- 'description' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'IntellijSearch',
- 'enum' => [
- 'UserUpload',
- 'IntellijSearch',
- 'HotViewPoint',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetProperties',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": {\\n \\"ChatConfig\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ConsoleConfig\\": {\\n \\"TipContent\\": \\"xx\\",\\n \\"Title\\": \\"AI妙笔\\"\\n },\\n \\"GeneralConfigMap\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"IntelligentSearchConfig\\": {\\n \\"ProductDescription\\": \\"xxx\\",\\n \\"SearchSamples\\": [\\n {\\n \\"Articles\\": [\\n {\\n \\"Select\\": true,\\n \\"Stared\\": false,\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"http://xxx.com\\"\\n }\\n ],\\n \\"Prompt\\": \\"xx\\",\\n \\"Text\\": \\"xxx\\"\\n }\\n ],\\n \\"SearchSources\\": [\\n {\\n \\"Code\\": \\"xx\\",\\n \\"DatasetName\\": \\"xx\\",\\n \\"Name\\": \\"xx\\"\\n }\\n ],\\n \\"CopilotPreciseSearchSources\\": [\\n {\\n \\"Code\\": \\"x\\",\\n \\"DatasetName\\": \\"x\\",\\n \\"Name\\": \\"x\\"\\n }\\n ]\\n },\\n \\"SearchSources\\": [\\n {\\n \\"Label\\": \\"夸克通用搜索\\",\\n \\"Value\\": \\"SystemSearch\\"\\n }\\n ],\\n \\"SlrAuthorized\\": true,\\n \\"UserInfo\\": {\\n \\"AgentId\\": \\"1\\",\\n \\"TenantId\\": \\"1\\",\\n \\"UserId\\": \\"1\\",\\n \\"Username\\": \\"admin\\"\\n },\\n \\"WanxiangImageSizeConfig\\": [\\n {\\n \\"Name\\": \\"1:1\\",\\n \\"Value\\": \\"1024*1024\\"\\n }\\n ],\\n \\"WanxiangImageStyleConfig\\": [\\n {\\n \\"Name\\": \\"默认\\",\\n \\"Pic\\": \\"https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png\\",\\n \\"Value\\": \\"<auto>\\"\\n }\\n ],\\n \\"SearchSourceList\\": [\\n {\\n \\"Code\\": \\"SystemSearch\\",\\n \\"Name\\": \\"互联网检索\\",\\n \\"DatasetName\\": \\"QuarkCommonNews\\"\\n }\\n ],\\n \\"MiaosouConfig\\": {\\n \\"UseDocSize\\": 1,\\n \\"MaxDocSize\\": 1,\\n \\"ModelInfos\\": [\\n {\\n \\"ModelName\\": \\"全妙-Max\\",\\n \\"ModelId\\": \\"quanmiao-max\\"\\n }\\n ]\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetSmartAuditResult' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TextContent',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '解析后的文本内容,对于图片来说为空',
- 'description' => '解析后的文本内容,对于图片来说为空',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文本内容',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'HtmlContent',
+ 'name' => 'TaskId',
'in' => 'formData',
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '带格式的内容',
- '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' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'description' => '审核结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消', 'description' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消', 'type' => 'string', 'example' => 'SUCCESSED'],
+ 'ErrorItemDetails' => [
+ 'description' => '审核错误明细列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Context' => ['title' => '原文片段', 'description' => '原文片段', 'type' => 'string', 'example' => '原文片段'],
+ 'MajorCodeDesc' => ['title' => '主错误描述', 'description' => '主错误描述', 'type' => 'string', 'example' => '内容准确性'],
+ 'ErrorWord' => ['title' => '错误单词', 'description' => '错误单词', 'type' => 'string', 'example' => '”xxx“'],
+ 'MajorCode' => ['title' => '主错误码', 'description' => '主错误码', 'type' => 'string', 'example' => 'ContentAccuracy'],
+ 'RightWord' => ['title' => '推荐修改的单词', 'description' => '推荐修改的单词', 'type' => 'string', 'example' => '“xxx”'],
+ 'Reason' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '中文双引号应成对正确使用,先左双引号,后右双引号'],
+ 'Url' => ['title' => '图片审核场景下,返回命中审核的可访问的图片的公网地址', 'description' => '图片审核场景下,返回命中审核的可访问的图片的公网地址', 'type' => 'string', 'example' => 'http://www.example.com/xxxx.jpg'],
+ 'Offset' => ['title' => '错误单词在全文的偏移索引', 'description' => '错误单词在全文的偏移索引', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'CheckId' => ['title' => '审核项唯一标识。(图片审核场景下为图片的ID)', 'description' => '审核项唯一标识。', 'type' => 'string', 'example' => '审核项唯一标识。'."\n"
+ ."\n"],
+ 'SubClassCode' => ['title' => '子错误码', 'description' => '子错误码', 'type' => 'string', 'example' => 'PunctuationError'],
+ 'ErrorLevel' => ['title' => '错误等级(1-严重,2-警告,3-提示,4-建议)', 'description' => '错误等级(1-严重,2-警告,3-提示,4-建议)', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'SubClassDesc' => ['title' => '子错误描述', 'description' => '子错误描述', 'type' => 'string', 'example' => '标点符号错误'."\n"],
+ 'ContextOffset' => ['title' => '错误单词在上下文(Context)中的偏移索引。', 'description' => '错误单词在上下文(Context)中的偏移索引。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ErrorMessage' => ['title' => '审核错误信息', 'description' => 'Status最终状态 不为SUCCESSED 时,需要读取此错误信息,判断错误', 'type' => 'string', 'example' => '审核被取消'],
+ ],
+ ],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询智能审校结果',
+ 'summary' => '查询智能审核结果',
+ 'changeSet' => [
+ ['createdAt' => '2025-08-04T09:48:13.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'ShareAttr',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '共享属性:0:个人私有,1:业务空间范围内共享',
- 'description' => '共享属性:0:个人私有,1:业务空间范围内共享',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetSmartAuditResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ErrorItemDetails\\": [\\n {\\n \\"Context\\": \\"原文片段\\",\\n \\"MajorCodeDesc\\": \\"内容准确性\\",\\n \\"ErrorWord\\": \\"”xxx“\\",\\n \\"MajorCode\\": \\"ContentAccuracy\\",\\n \\"RightWord\\": \\"“xxx”\\",\\n \\"Reason\\": \\"中文双引号应成对正确使用,先左双引号,后右双引号\\",\\n \\"Url\\": \\"http://www.example.com/xxxx.jpg\\",\\n \\"Offset\\": 0,\\n \\"CheckId\\": \\"审核项唯一标识。\\\\n\\\\n\\",\\n \\"SubClassCode\\": \\"PunctuationError\\",\\n \\"ErrorLevel\\": 2,\\n \\"SubClassDesc\\": \\"标点符号错误\\\\n\\",\\n \\"ContextOffset\\": 0\\n }\\n ],\\n \\"ErrorMessage\\": \\"审核被取消\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'GetSmartClipTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'BothSavePrivateAndShare',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否同时将素材保存为私有库与共享库',
- 'description' => '是否同时将素材保存为私有库与共享库',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'Summary',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '摘要',
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => 'task-03d46184ee7d8749'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'title' => '任务响应结果',
+ 'description' => '任务响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Status' => ['title' => '任务状态:'."\n"
+ .' PENDING:待执行'."\n"
+ .' RUNNING:执行中'."\n"
+ .' SUCCESSED:成功'."\n"
+ .' FAILED:失败'."\n"
+ .' CANCELED:已取消', 'description' => '任务状态:'."\n"
+ .' PENDING:待执行'."\n"
+ .' RUNNING:执行中'."\n"
+ .' SUCCESSED:成功'."\n"
+ .' FAILED:失败'."\n"
+ .' CANCELED:已取消', 'type' => 'string', 'example' => 'RUNNING'],
+ 'ErrorMessage' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误信息'],
+ 'SubJobs' => [
+ 'title' => '子任务列表',
+ 'description' => '子任务列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '子任务',
+ 'description' => '子任务',
+ 'type' => 'object',
+ 'properties' => [
+ 'SubJobId' => ['title' => '子任务ID', 'description' => '子任务ID', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Status' => ['title' => '子任务状态'."\n"
+ .' PENDING:待执行'."\n"
+ .' RUNNING:执行中'."\n"
+ .' SUCCESSED:成功'."\n"
+ .' FAILED:失败'."\n"
+ .' CANCELED:已取消', 'description' => '子任务状态'."\n"
+ .' PENDING:待执行'."\n"
+ .' RUNNING:执行中'."\n"
+ .' SUCCESSED:成功'."\n"
+ .' FAILED:失败'."\n"
+ .' CANCELED:已取消', 'type' => 'string', 'example' => 'RUNNING'],
+ 'ErrorMessage' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '文件名错误'],
+ 'FileKey' => ['title' => '文件FileKey', 'description' => '文件FileKey', 'type' => 'string', 'example' => 'oss://default/bucket-name/path-xxx/xxx-1.mp4'],
+ 'FileAttr' => [
+ 'title' => '文件属性',
+ 'description' => '文件属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileName' => ['title' => '视频文件名称', 'description' => '视频文件名称', 'type' => 'string', 'example' => '2024-12-12.mp4'],
+ 'FileLength' => ['title' => '视频文件大小', 'description' => '视频文件大小', 'type' => 'string', 'example' => '290804'],
+ 'TmpUrl' => ['title' => '视频文件临时访问URL。1小时过期', 'description' => '视频文件临时访问URL。1小时过期', 'type' => 'string', 'example' => 'http://www.example.com/tmp.mp4'],
+ 'Duration' => ['title' => '视频时长,单位秒', 'description' => '视频时长,单位秒', 'type' => 'number', 'format' => 'double', 'example' => '120'],
+ 'Height' => ['title' => '视频高度', 'description' => '视频高度', 'type' => 'integer', 'format' => 'int32', 'example' => '1080'],
+ 'Width' => ['title' => '视频宽度', 'description' => '视频宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
],
+ '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'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": 12,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => '保存素材',
- ],
- 'DeleteMaterialById' => [
- 'summary' => '删除素材:删除素材库中素材。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取智能剪辑任务结果',
+ 'summary' => '查询一键成片剪辑任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetSmartClipTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"SubJobs\\": [\\n {\\n \\"SubJobId\\": \\"xxxxx\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"文件名错误\\",\\n \\"FileKey\\": \\"oss://default/bucket-name/path-xxx/xxx-1.mp4\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"2024-12-12.mp4\\",\\n \\"FileLength\\": \\"290804\\",\\n \\"TmpUrl\\": \\"http://www.example.com/tmp.mp4\\",\\n \\"Duration\\": 120,\\n \\"Height\\": 1080,\\n \\"Width\\": 1920\\n }\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetStyleLearningResult' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '文体学习ID', 'description' => '文体学习ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '39'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '返回是否删除成功',
- 'description' => '返回是否删除成功',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'AigcResult' => ['title' => 'AIGC 生成的内容', 'description' => 'AIGC 生成的内容', 'type' => 'string', 'example' => 'AIGC 生成的内容'],
+ 'ContentList' => [
+ 'title' => '自定义内容实体内容',
+ 'description' => '自定义内容实体内容',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '内容'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '创建时间'],
+ 'CreateUser' => ['title' => '创建用户', 'description' => '创建用户', 'type' => 'string', 'example' => '创建用户'],
+ 'Id' => ['description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '修改时间'],
+ 'UpdateUser' => ['title' => '修改用户', 'description' => '修改用户', 'type' => 'string', 'example' => '修改用户'],
+ ],
+ ],
+ ],
+ 'CustomTextIdList' => [
+ 'title' => '自定义内容ID集合',
+ 'description' => '自定义内容ID集合',
+ 'type' => 'array',
+ 'items' => ['description' => '自定义内容ID', 'type' => 'integer', 'format' => 'int64', 'example' => '25'],
+ ],
+ 'Id' => ['title' => '文体学习分析结果ID', 'description' => '文体学习分析结果ID', 'type' => 'integer', 'format' => 'int64', 'example' => '33'],
+ 'MaterialIdList' => [
+ 'title' => '素材ID集合',
+ 'description' => '素材ID集合',
+ 'type' => 'array',
+ 'items' => ['description' => '素材库ID', 'type' => 'integer', 'format' => 'int64', 'example' => '4'],
+ ],
+ 'MaterialInfoList' => [
+ 'title' => '素材详细信息',
+ 'description' => '素材详细信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '创建时间'],
+ 'CreateUser' => ['title' => '创建用户ID', 'description' => '创建用户ID', 'type' => 'string', 'example' => '创建用户ID'],
+ 'CreateUserName' => ['title' => '创建用户姓名', 'description' => '创建用户姓名', 'type' => 'string', 'example' => '创建用户姓名'],
+ 'DocKeywords' => [
+ 'title' => '文档标签用于分类等、不同keyword之间逗号分割',
+ 'description' => '文档标签用于分类等、不同keyword之间逗号分割',
+ 'type' => 'array',
+ 'items' => ['description' => '关键词', 'type' => 'string', 'example' => '中欧'],
+ ],
+ 'DocType' => ['title' => '文档类型,pdf、word、url、image', 'description' => '文档类型,pdf、word、url、image', 'type' => 'string', 'example' => '文档类型,pdf、word、url、image'],
+ 'ExternalUrl' => ['title' => '外部客户上传的URL,仅用作记录保存', 'description' => '外部客户上传的URL,仅用作记录保存', 'type' => 'string', 'example' => '外部客户上传的URL,仅用作记录保存'],
+ 'FileLength' => ['title' => '文件内容长度', 'description' => '文件内容长度', 'type' => 'integer', 'format' => 'int32', 'example' => '41'],
+ 'HtmlContent' => ['title' => '解析后的原始html内容', 'description' => '解析后的原始html内容', 'type' => 'string', 'example' => '解析后的原始html内容'],
+ 'Id' => ['title' => '主键', 'description' => '主键', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '发布时间'],
+ 'PublicUrl' => ['title' => '临时的对外公开的URL', 'description' => '临时的对外公开的URL', 'type' => 'string', 'example' => '临时的对外公开的URL'],
+ 'ShareAttr' => [
+ 'title' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
+ 'description' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'enum' => ['0', '1'],
+ ],
+ 'SrcFrom' => ['title' => '文档来源,user_upload、search、viewpoint', 'description' => '文档来源,user_upload、search、viewpoint', 'type' => 'string', 'example' => '文档来源,user_upload、search、viewpoint'],
+ 'Summary' => ['title' => '文档摘要', 'description' => '文档摘要', 'type' => 'string', 'example' => '文档摘要'],
+ 'TextContent' => ['title' => '解析后的文本内容,对于图片来说为空', 'description' => '解析后的文本内容,对于图片来说为空', 'type' => 'string', 'example' => '解析后的文本内容,对于图片来说为空'],
+ 'ThumbnailInBase64' => ['title' => '图片文档类型的Base64缩略图', 'description' => '图片文档类型的Base64缩略图', 'type' => 'string', 'example' => '图片文档类型的Base64缩略图'],
+ 'Title' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'example' => '文档标题'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '修改时间'],
+ 'UpdateUser' => ['title' => '修改用户ID', 'description' => '修改用户ID', 'type' => 'string', 'example' => '修改用户ID'],
+ 'UpdateUserName' => ['title' => '修改用户姓名', 'description' => '修改用户姓名', 'type' => 'string', 'example' => '修改用户姓名'],
+ 'Url' => ['title' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除', 'description' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除', 'type' => 'string', 'example' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'RewriteResult' => ['title' => '用户修订后内容', 'description' => '用户修订后内容', 'type' => 'string', 'example' => '用户修订后内容'],
+ 'StyleName' => ['title' => '文体风格名称', 'description' => '用户修订后内容', 'type' => 'string', 'example' => '用户修订后内容'],
+ 'TaskId' => ['title' => '文体分析时的任务ID', 'description' => '文体分析时的任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
],
+ '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'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => '删除素材',
- ],
- 'UpdateMaterialDocument' => [
- 'summary' => '更新素材:更新素材库中素材。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取文体学习分析结果',
+ 'summary' => '获取文体学习分析结果。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"AigcResult\\": \\"AIGC 生成的内容\\",\\n \\"ContentList\\": [\\n {\\n \\"Content\\": \\"内容\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CreateUser\\": \\"创建用户\\",\\n \\"Id\\": 1,\\n \\"Title\\": \\"标题\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"UpdateUser\\": \\"修改用户\\"\\n }\\n ],\\n \\"CustomTextIdList\\": [\\n 25\\n ],\\n \\"Id\\": 33,\\n \\"MaterialIdList\\": [\\n 4\\n ],\\n \\"MaterialInfoList\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CreateUser\\": \\"创建用户ID\\",\\n \\"CreateUserName\\": \\"创建用户姓名\\",\\n \\"DocKeywords\\": [\\n \\"中欧\\"\\n ],\\n \\"DocType\\": \\"文档类型,pdf、word、url、image\\",\\n \\"ExternalUrl\\": \\"外部客户上传的URL,仅用作记录保存\\",\\n \\"FileLength\\": 41,\\n \\"HtmlContent\\": \\"解析后的原始html内容\\",\\n \\"Id\\": 50,\\n \\"PubTime\\": \\"发布时间\\",\\n \\"PublicUrl\\": \\"临时的对外公开的URL\\",\\n \\"ShareAttr\\": 1,\\n \\"SrcFrom\\": \\"文档来源,user_upload、search、viewpoint\\",\\n \\"Summary\\": \\"文档摘要\\",\\n \\"TextContent\\": \\"解析后的文本内容,对于图片来说为空\\",\\n \\"ThumbnailInBase64\\": \\"图片文档类型的Base64缩略图\\",\\n \\"Title\\": \\"文档标题\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"UpdateUser\\": \\"修改用户ID\\",\\n \\"UpdateUserName\\": \\"修改用户姓名\\",\\n \\"Url\\": \\"内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除\\"\\n }\\n ],\\n \\"RewriteResult\\": \\"用户修订后内容\\",\\n \\"StyleName\\": \\"用户修订后内容\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetTopicById' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'title' => '主键',
- 'description' => '主键',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '44',
- ],
+ 'schema' => ['title' => '数据ID', 'description' => '数据ID', 'type' => 'string', 'required' => true, 'example' => '数据ID'],
],
- [
- 'name' => 'DocType',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'description' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'image',
- 'enum' => [
- 'html',
- 'plainText',
- 'image',
- 'pdf',
- 'word',
- 'excel',
- 'csv',
- 'jsonLine',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'AsyncTaskId' => ['title' => '异步任务ID(自定义主题场景下使用)', 'description' => '异步任务ID(自定义主题场景下使用)', 'type' => 'string', 'example' => '异步任务ID(自定义主题场景下使用)'],
+ 'CreateUser' => ['title' => '创建用户ID(自定义主题场景下使用)', 'description' => '创建用户ID(自定义主题场景下使用)', 'type' => 'string', 'example' => '创建用户ID(自定义主题场景下使用)'],
+ 'HotValue' => ['title' => '热度值', 'description' => '热度值', 'type' => 'integer', 'format' => 'int64', 'example' => '43'],
+ 'Id' => ['title' => '热榜ID', 'description' => '热榜ID', 'type' => 'string', 'example' => '热榜ID'],
+ 'Status' => [
+ 'title' => '异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'description' => '异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'type' => 'string',
+ 'example' => 'PENDING',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
+ ],
+ 'StructureSummary' => [
+ 'title' => '结构化主题摘要列表',
+ 'description' => '结构化主题摘要列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '结构化主题摘要对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocList' => [
+ 'title' => '生成该标题摘要引用的文章',
+ 'description' => '生成该标题摘要引用的文章',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '文章源', 'type' => 'string', 'example' => '头条'],
+ 'Title' => ['description' => '文章标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Url' => ['description' => '文章URL', 'type' => 'string', 'example' => 'http://www.example.com'],
+ ],
+ ],
+ ],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ ],
+ ],
+ ],
+ 'Summary' => ['title' => '热榜摘要', 'description' => '热榜摘要', 'type' => 'string', 'example' => '热榜摘要'],
+ 'TaskErrorMessage' => ['title' => '异步任务失败错误信息', 'description' => '异步任务失败错误信息', 'type' => 'string', 'example' => '异步任务失败错误信息'],
+ 'TaskStatus' => ['title' => '异步任务状态.0-待执行,1-执行中,2-执行成功 3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)', 'description' => '异步任务状态。0-待执行,1-执行中,2-执行成功,3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)。', 'type' => 'integer', 'format' => 'int32', 'example' => '14'],
+ 'Topic' => ['title' => '主题唯一名称', 'description' => '主题唯一名称', 'type' => 'string', 'example' => '主题唯一名称'],
+ 'TopicSource' => ['title' => '热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜', 'description' => '热榜源,目前支持的热榜源:'."\n"
+ ."\n"
+ .'- Toutiao:头条'."\n"
+ ."\n"
+ .'- Quark:夸克'."\n"
+ ."\n"
+ .'- Baidu:百度'."\n"
+ ."\n"
+ .'- Sina:新浪'."\n"
+ ."\n"
+ .'- Custom:自定义'."\n"
+ ."\n"
+ .'- Aggregation:热点话题榜', 'type' => 'string', 'example' => 'Toutiao'],
+ 'Version' => ['title' => '数据版本', 'description' => '数据版本', 'type' => 'string', 'example' => '数据版本'],
+ ],
+ ],
+ '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'],
],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取热点对象',
+ 'summary' => '根据ID获取热点事件信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档标题',
- 'description' => '文档标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标题',
- ],
- ],
- [
- 'name' => 'Author',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'required' => false,
- 'example' => '作者名称',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetTopicById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"AsyncTaskId\\": \\"异步任务ID(自定义主题场景下使用)\\",\\n \\"CreateUser\\": \\"创建用户ID(自定义主题场景下使用)\\",\\n \\"HotValue\\": 43,\\n \\"Id\\": \\"热榜ID\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"StructureSummary\\": [\\n {\\n \\"DocList\\": [\\n {\\n \\"Source\\": \\"头条\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"http://www.example.com\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ],\\n \\"Summary\\": \\"热榜摘要\\",\\n \\"TaskErrorMessage\\": \\"异步任务失败错误信息\\",\\n \\"TaskStatus\\": 14,\\n \\"Topic\\": \\"主题唯一名称\\",\\n \\"TopicSource\\": \\"Toutiao\\",\\n \\"Version\\": \\"数据版本\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'GetTopicSelectionPerspectiveAnalysisTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'PubTime',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-04-11 06:14:07',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
[
- 'name' => 'DocKeywords',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '文档标签用于分类等',
- 'description' => '文档标签用于分类等',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关键词',
- ],
- 'required' => false,
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'Url',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '素材的URL',
- 'description' => '素材的URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxxx/xxx',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2'],
],
- [
- 'name' => 'ExternalUrl',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '外部客户上传的URL,仅用作记录保存',
- 'description' => '外部客户上传的URL,仅用作记录保存',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxxx/xxx',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'FreshViewPointsResult' => [
+ 'title' => '新颖选题视角分析结果',
+ 'description' => '新颖选题视角分析结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitudes' => [
+ 'title' => '新颖选题视角-观点列表',
+ 'description' => '新颖选题视角-观点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '大纲列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ ],
+ ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ 'HotViewPointsResult' => [
+ 'title' => '热门选题视角分析结果',
+ 'description' => '热门选题视角分析结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitudes' => [
+ 'title' => '热门选题视角-观点列表',
+ 'description' => '热门选题视角-观点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '热门选题视角-观点列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'News' => [
+ 'title' => '相关新闻列表',
+ 'description' => '相关新闻列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '新闻对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '新闻内容', 'description' => '新闻内容', 'type' => 'string', 'example' => 'Content'],
+ 'DocId' => ['description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '9957175DEDCF49C5ACF7A956B4FD67B2'],
+ 'DocUuid' => ['title' => '文章唯一ID', 'description' => '文章唯一ID', 'type' => 'string', 'example' => '"123456"'],
+ 'ImageUrls' => [
+ 'title' => '文章配图URL',
+ 'description' => '文章配图URL',
+ 'type' => 'array',
+ 'items' => ['description' => '文章图片外链', 'type' => 'string', 'example' => 'https://www.example.com/aaa.png'],
+ 'example' => 'https://www.example.com/aaa.png',
+ ],
+ 'Source' => ['title' => '新闻来源', 'description' => '新闻来源', 'type' => 'string', 'example' => '夸克'],
+ 'Summary' => ['title' => '新闻摘要', 'description' => '新闻摘要', 'type' => 'string', 'example' => '新闻摘要'],
+ 'Tags' => [
+ 'title' => '标签',
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => ['description' => '文章标签', 'type' => 'string', 'example' => '["标签1","标签2"]'],
+ 'example' => '["标签1","标签2"]',
+ ],
+ 'Title' => ['title' => '新闻标题', 'description' => '新闻标题', 'type' => 'string', 'example' => '新闻标题'],
+ 'Topic' => ['title' => '文章主题', 'description' => '文章主题', 'type' => 'string', 'example' => '文章主题'],
+ 'Url' => ['title' => 'URL链接', 'description' => 'URL链接', 'type' => 'string', 'example' => 'http://www.example.com'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-05-08 02:23:01'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-05-08 02:23:02'],
+ ],
+ ],
+ ],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '大纲对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ ],
+ ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Status' => [
+ 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'description' => '任务状态(PENDING:待执行, RUNNING:执行中, SUCCESSED:成功, SUSPENDED:暂停, FAILED:失败, CANCELED:取消)',
+ 'type' => 'string',
+ 'example' => 'SUSPENDED',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
+ ],
+ 'TimedViewPointsResult' => [
+ 'title' => '时效性选题视角分析结果',
+ 'description' => '时效性选题视角分析结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitudes' => [
+ 'title' => '时效性选题视角-观点列表',
+ 'description' => '时效性选题视角-观点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '观点对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-01-22 10:29'],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'Source' => ['title' => '新闻来源', 'description' => '新闻来源', 'type' => 'string', 'example' => '新浪'],
+ 'Title' => ['title' => '当前观点 等价于 新闻标题', 'description' => '当前观点,等价于新闻标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['title' => '新闻URL', 'description' => '新闻URL', 'type' => 'string', 'example' => 'http://www.example.com/news/1.html'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '视角对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '大纲对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ ],
+ ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Topic' => ['title' => '热点主题事件', 'description' => '热点主题事件', 'type' => 'string', 'example' => '热点主题事件'],
+ 'TopicSummaryResult' => [
+ 'title' => '热点主题事件摘要',
+ 'description' => '热点主题事件摘要',
+ 'type' => 'object',
+ 'properties' => [
+ 'Summaries' => [
+ 'title' => '摘要列表',
+ 'description' => '摘要列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '摘要对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocList' => [
+ 'title' => '生成该标题摘要引用的文章',
+ 'description' => '生成该标题摘要引用的文章',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['description' => '文章源', 'type' => 'string', 'example' => '头条'],
+ 'Title' => ['description' => '文章标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['description' => '文章URL', 'type' => 'string', 'example' => 'http://www.example.com'],
+ ],
+ ],
+ ],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'WebReviewPointsResult' => [
+ 'title' => '网评选题视角分析结果',
+ 'description' => '网评选题视角分析结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitudes' => [
+ 'title' => '网友选题视角-观点列表',
+ 'description' => '网友选题视角-观点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'Comments' => [
+ 'title' => '网友评论列表',
+ 'description' => '网友观点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '来源'],
+ 'Text' => ['title' => '评论内容', 'description' => '内容', 'type' => 'string', 'example' => '内容'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['title' => '当前评论所属的URL', 'description' => '当前所属的URL', 'type' => 'string', 'example' => '当前所属的URL'],
+ 'Username' => ['title' => '评论用户名', 'description' => '用户名', 'type' => 'string', 'example' => '用户名'],
+ ],
+ ],
+ ],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '大纲对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ ],
+ ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ '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'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取选题视角分析任务结果',
+ 'summary' => '获取选题视角分析任务结果。',
+ 'changeSet' => [
+ ['createdAt' => '2024-10-28T03:52:21.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-09-19T13:07:53.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SrcFrom',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
- 'description' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'UserUpload',
- 'enum' => [
- 'UserUpload',
- 'IntellijSearch',
- 'HotViewPoint',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"FreshViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"HotViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"News\\": [\\n {\\n \\"Content\\": \\"Content\\",\\n \\"DocId\\": \\"9957175DEDCF49C5ACF7A956B4FD67B2\\",\\n \\"DocUuid\\": \\"\\\\\\"123456\\\\\\"\\",\\n \\"ImageUrls\\": [\\n \\"https://www.example.com/aaa.png\\"\\n ],\\n \\"Source\\": \\"夸克\\",\\n \\"Summary\\": \\"新闻摘要\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"标签1\\\\\\",\\\\\\"标签2\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"新闻标题\\",\\n \\"Topic\\": \\"文章主题\\",\\n \\"Url\\": \\"http://www.example.com\\",\\n \\"CreateTime\\": \\"2024-05-08 02:23:01\\",\\n \\"PubTime\\": \\"2024-05-08 02:23:02\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Status\\": \\"SUSPENDED\\",\\n \\"TimedViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"PubTime\\": \\"2024-01-22 10:29\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"Source\\": \\"新浪\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com/news/1.html\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Topic\\": \\"热点主题事件\\",\\n \\"TopicSummaryResult\\": {\\n \\"Summaries\\": [\\n {\\n \\"DocList\\": [\\n {\\n \\"Source\\": \\"头条\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ]\\n },\\n \\"WebReviewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Comments\\": [\\n {\\n \\"Source\\": \\"来源\\",\\n \\"Text\\": \\"内容\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"当前所属的URL\\",\\n \\"Username\\": \\"用户名\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ImportInterveneFile' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TextContent',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '解析后的文本内容,对于图片来说为空',
- 'description' => '解析后的文本内容,对于图片来说为空',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文本内容',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'HtmlContent',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '带格式的内容',
- 'description' => '带格式的内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '网页内容',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'ShareAttr',
+ 'name' => 'DocName',
'in' => 'formData',
- 'schema' => [
- 'title' => '共享属性:0:个人私有,1:业务空间范围内共享',
- 'description' => '共享属性:0:个人私有,1:业务空间范围内共享',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
+ 'schema' => ['title' => '上传文件名字', 'description' => '上传文件名字', 'type' => 'string', 'required' => false, 'example' => 'import.xls'],
],
[
- 'name' => 'Summary',
+ 'name' => 'FileUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '摘要',
- ],
+ 'schema' => ['title' => '文件地址', 'description' => '文件地址', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.xls'],
],
[
- 'name' => 'RegionId',
- 'in' => 'query',
- 'schema' => [
- 'type' => 'string',
- 'required' => false,
- ],
+ 'name' => 'FileKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文件osskey', 'description' => '文件osskey', 'type' => 'string', 'required' => false, 'example' => 'import.xsl'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<Long>',
- 'description' => 'PlainResult<Long>',
+ 'title' => 'PlainResult<OperationResult>',
+ 'description' => 'PlainResult<OperationResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '82',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
+ 'type' => 'object',
+ 'properties' => [
+ 'FailIdList' => [
+ 'title' => '失败的索引id列表',
+ 'description' => '失败的索引id列表',
+ 'type' => 'array',
+ 'items' => ['description' => '失败干预项Id', 'type' => 'string', 'example' => '123456'],
+ ],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => '"3f7045e099474ba28ceca1b4eb6d6e21"'],
+ 'Code' => ['description' => '干预状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '同步导入干预项文件',
+ 'summary' => '导入干预文件。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": 82,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => '更新素材',
- ],
- 'GetMaterialById' => [
- 'summary' => '获取素材:获取素材库中素材详细信息。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ImportInterveneFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"123456\\"\\n ],\\n \\"TaskId\\": \\"\\\\\\"3f7045e099474ba28ceca1b4eb6d6e21\\\\\\"\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ImportInterveneFileAsync' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
],
[
- 'name' => 'Id',
+ 'name' => 'DocName',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '60',
- ],
+ 'schema' => ['title' => '上传文件名字', 'description' => '上传文件名字', 'type' => 'string', 'required' => false, 'example' => 'import.xls'],
+ ],
+ [
+ 'name' => 'FileUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文件地址', 'description' => '文件地址', 'type' => 'string', 'required' => false, 'example' => 'https://xxx/import.xls'],
+ ],
+ [
+ 'name' => 'FileKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文件osskey', 'description' => '文件osskey', 'type' => 'string', 'required' => false, 'example' => 'import.xls'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult<MaterialDocumentDO>',
- 'description' => 'PlainResult<MaterialDocumentDO>',
+ 'title' => 'PlainResult<OperationResult>',
+ 'description' => 'PlainResult<OperationResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '文档作者',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-03-21 11:34:19',
- ],
- 'CreateUser' => [
- 'title' => '创建用户ID',
- 'description' => '创建用户ID',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'DocKeywords' => [
- 'title' => '文档标签用于分类等、不同keyword之间逗号分割',
- 'description' => '文档标签用于分类等、不同keyword之间逗号分割',
+ 'FailIdList' => [
+ 'title' => '失败的索引id列表',
+ 'description' => '失败的索引id列表',
'type' => 'array',
- 'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'example' => '关键词',
- ],
- ],
- 'DocType' => [
- 'title' => '文档类型,pdf、word、url、image',
- 'description' => '文档类型,pdf、word、url、image',
- 'type' => 'string',
- 'example' => 'pdf',
- ],
- 'ExternalUrl' => [
- 'title' => '外部客户上传的URL,仅用作记录保存',
- 'description' => '外部客户上传的URL,仅用作记录保存',
- 'type' => 'string',
- 'example' => 'https://www.example.com'."\n",
- ],
- 'HtmlContent' => [
- 'description' => '网页内容',
- 'type' => 'string',
- 'example' => '网页内容',
- ],
- 'Id' => [
- 'title' => '主键',
- 'description' => '主键',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '32',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2023-04-11 06:14:07'."\n",
- ],
- 'PublicUrl' => [
- 'title' => '临时的对外公开的URL',
- 'description' => '临时的对外公开的URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com'."\n",
- ],
- 'ShareAttr' => [
- 'title' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
- 'description' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
- 'SrcFrom' => [
- 'title' => '文档来源,user_upload、search、viewpoint',
- 'description' => '文档来源,user_upload、search、viewpoint',
- 'type' => 'string',
- 'example' => 'user_upload',
- ],
- 'Summary' => [
- 'title' => '文档摘要',
- 'description' => '文档摘要',
- 'type' => 'string',
- 'example' => '文档摘要',
- ],
- 'TextContent' => [
- 'title' => '解析后的文本内容,对于图片来说为空',
- 'description' => '解析后的文本内容,对于图片来说为空',
- 'type' => 'string',
- 'example' => '文本内容',
- ],
- 'ThumbnailInBase64' => [
- 'title' => '图片文档类型的Base64缩略图',
- 'description' => '图片文档类型的Base64缩略图',
- 'type' => 'string',
- 'example' => 'Base64编码的缩略图',
- ],
- 'Title' => [
- 'title' => '文档标题',
- 'description' => '文档标题',
- 'type' => 'string',
- 'example' => '文档标题',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2022-04-08 19:33:01',
- ],
- 'UpdateUser' => [
- 'title' => '修改用户ID',
- 'description' => '修改用户ID',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Url' => [
- 'title' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除',
- 'description' => '内部文档保存的URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com',
+ 'items' => ['description' => '失败的干预项id', 'type' => 'string', 'example' => '123'],
],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Code' => ['description' => '干预服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '异步导入干预项文件',
+ 'summary' => '异步导入干预文件。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": {\\n \\"Author\\": \\"文档作者\\",\\n \\"CreateTime\\": \\"2023-03-21 11:34:19\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"DocKeywords\\": [\\n \\"关键词\\"\\n ],\\n \\"DocType\\": \\"pdf\\",\\n \\"ExternalUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"HtmlContent\\": \\"网页内容\\",\\n \\"Id\\": 32,\\n \\"PubTime\\": \\"2023-04-11 06:14:07\\\\n\\",\\n \\"PublicUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"ShareAttr\\": 1,\\n \\"SrcFrom\\": \\"user_upload\\",\\n \\"Summary\\": \\"文档摘要\\",\\n \\"TextContent\\": \\"文本内容\\",\\n \\"ThumbnailInBase64\\": \\"Base64编码的缩略图\\",\\n \\"Title\\": \\"文档标题\\",\\n \\"UpdateTime\\": \\"2022-04-08 19:33:01\\",\\n \\"UpdateUser\\": \\"1\\",\\n \\"Url\\": \\"https://www.example.com\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => '获取素材',
- ],
- 'ListMaterialDocuments' => [
- 'summary' => '获取素材列表:获取素材库中素材列表。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ImportInterveneFileAsync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"123\\"\\n ],\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'InitiatePptCreation' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public',
- ],
- ],
- [
- 'name' => 'Query',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '支持对 title、content、content的综合查询',
- 'description' => '支持对 title、content、content的综合查询',
- 'type' => 'string',
- 'required' => false,
- 'example' => '小猫',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-3fy94b2rtadt01qa'],
],
[
- 'name' => 'Id',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '素材主键ID',
- 'description' => '素材主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '69',
- ],
+ 'schema' => ['title' => '指令', 'description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => '95c2fbe6-5a20-4fc2-8a93-376ed05fbe13'],
],
[
- 'name' => 'Title',
+ 'name' => 'Outline',
'in' => 'formData',
- 'schema' => [
- 'title' => '根据素材标题全文检索',
- 'description' => '根据素材标题全文检索',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新闻标题',
- ],
+ 'schema' => ['description' => '大纲', 'type' => 'string', 'required' => false, 'example' => '# 中国传统文化艺术的魅力'."\n"
+ ."\n"
+ .'## 1. 传统文化艺术的源远流长'."\n"
+ ."\n"
+ .'### 1.1 中国古代艺术发展历程'."\n"
+ ."\n"
+ .'#### 1.1.1 古代绘画艺术的演变'."\n"
+ .'- 从新石器时代的彩陶绘画到东汉时期帛画的出现,绘画形式不断丰富,展现了古人对美的独特追求。唐代绘画风格多样,吴道子的《送子天王图》线条流畅,色彩绚丽,体现了唐代绘画的高超技艺。'."\n"
+ ."\n"
+ .'#### 1.1.2 书法艺术的传承与创新'."\n"
+ .'- 书法从甲骨文到楷书、行书、草书,历经数千年演变,承载着中华文化的深厚内涵。王羲之的《兰亭序》被誉为“天下第一行书”,其笔法精妙,结构严谨,展现了书法艺术的巅峰。'],
],
[
- 'name' => 'DocType',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
+ 'schema' => ['type' => 'string', 'example' => 'abc'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'description' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'jsonLine',
- 'enum' => [
- 'html',
- 'plainText',
- 'image',
- 'pdf',
- 'word',
- 'excel',
- 'csv',
- 'jsonLine',
- 'video',
- 'text',
+ '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' => '11AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '',
+ 'description' => '返回数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppKey' => ['title' => 'AppKey', 'description' => 'AppKey', 'type' => 'string', 'example' => 'S1X5ecouBztZelaQ'],
+ 'Code' => ['title' => 'Code', 'description' => 'Code', 'type' => 'string', 'example' => '7dhqd2'],
+ ],
+ ],
],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '初始化用来创建PPT的会话',
+ 'summary' => '重要说明:这个接口涉及到扣费,请注意费用'."\n"
+ ."\n"
+ .'这个接口包含两个操作:'."\n"
+ .'1. 下发用于初始化“PPT生成”的前端组件的code'."\n"
+ .'2. 进行计费',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'DocTypeList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '文档类型列表 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'description' => '文档类型列表 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
- 'type' => 'array',
- 'items' => [
- 'description' => '文件类型对象。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'html',
- 'enum' => [
- 'html',
- 'plainText',
- 'image',
- 'pdf',
- 'word',
- 'excel',
- 'csv',
- 'jsonLine',
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InitiatePptCreation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
- 'example' => 'excel',
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"AppKey\\": \\"S1X5ecouBztZelaQ\\",\\n \\"Code\\": \\"7dhqd2\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'InitiatePptCreationV2' => [
+ 'summary' => '初始化PPT创建操作V2',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档内容全文检索',
- 'description' => '文档内容全文检索',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新闻内容',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
[
- 'name' => 'ShareAttr',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '共享属性:0:个人私有,1:业务空间范围内共享',
- 'description' => '共享属性:0:个人私有,1:业务空间范围内共享',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'Keywords',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '文档关键词',
- 'description' => '文档关键词',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关键词',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => '8a7dfece-f204-4380-a7d0-a13d37de3924'],
],
[
- 'name' => 'CreateTimeStart',
+ 'name' => 'ProcessType',
'in' => 'formData',
'schema' => [
- 'title' => '创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss',
- 'description' => '创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
+ 'title' => '处理类型,'."\n"
+ .'0:只生成签名,用于初始化前端SDK,完成整个制作流程'."\n"
+ .'1:生成和签名和处理流程ID,用于自行开发‘模版’前端页面,然后初始化前端SDK'."\n"
+ .'2:生成作品ID,可以直接进行作品的编辑'."\n"
+ .'3:生成导出任务ID,可以轮询导出任务ID获取导出结果',
+ 'description' => '处理类型<br/>'."\n"
+ .'0:只生成签名,用于初始化前端SDK,完成整个制作流程<br/>'."\n"
+ .'1:生成和签名和处理流程ID,用于自行开发‘模版’前端页面,然后初始化前端SDK<br/>'."\n"
+ .'2:生成作品ID,可以直接进行作品的编辑<br/>'."\n"
+ .'3:生成导出任务ID,可以轮询导出任务ID获取导出结果',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '2023-02-19 07:28:11',
+ 'example' => '1',
+ 'enum' => ['0', '1', '2', '3', '4'],
],
],
[
- 'name' => 'CreateTimeEnd',
+ 'name' => 'PptTemplateType',
'in' => 'formData',
'schema' => [
- 'title' => '创建时间-结束范围,格式:yyyy-MM-dd HH:mm:ss',
- 'description' => '创建时间-结束范围,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
+ 'title' => '模板类型,默认为1,1:系统模板,2: 企业模板',
+ 'description' => '模板类型,默认为1,1:系统模板,2: 企业模板',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '2023-03-18 02:00:00',
+ 'example' => '1',
+ 'enum' => ['1', '2'],
],
],
[
- 'name' => 'UpdateTimeStart',
+ 'name' => 'PptTemplateId',
'in' => 'formData',
- 'schema' => [
- 'title' => '更新时间-开始范围,格式:yyyy-MM-dd HH:mm:ss',
- 'description' => '更新时间-开始范围,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-18 02:00:00'."\n",
- ],
+ 'schema' => ['title' => 'PPT模板ID', 'description' => 'PPT模板ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500'],
],
[
- 'name' => 'UpdateTimeEnd',
+ 'name' => 'PptTitle',
'in' => 'formData',
- 'schema' => [
- 'title' => '更新时间-结束范围,格式:yyyy-MM-dd HH:mm:ss',
- 'description' => '更新时间-结束范围,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-18 03:00:00'."\n",
- ],
+ 'schema' => ['title' => 'PPT标题', 'type' => 'string', 'example' => '中国传统文化艺术的魅力'],
],
[
- 'name' => 'GeneratePublicUrl',
+ 'name' => 'Outline',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否生成文件公共URL',
- 'description' => '是否生成文件公共URL',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => 'PPT大纲', 'description' => 'PPT大纲', 'type' => 'string', 'required' => false, 'example' => '# 中国传统文化艺术的魅力'."\n"
+ ."\n"
+ .'## 1. 传统文化艺术的源远流长'."\n"
+ ."\n"
+ .'### 1.1 中国古代艺术发展历程'."\n"
+ ."\n"
+ .'#### 1.1.1 古代绘画艺术的演变'."\n"
+ .'- 从新石器时代的彩陶绘画到东汉时期帛画的出现,绘画形式不断丰富,展现了古人对美的独特追求。唐代绘画风格多样,吴道子的《送子天王图》线条流畅,色彩绚丽,体现了唐代绘画的高超技艺。'."\n"
+ ."\n"
+ .'#### 1.1.2 书法艺术的传承与创新'."\n"
+ .'- 书法从甲骨文到楷书、行书、草书,历经数千年演变,承载着中华文化的深厚内涵。王羲之的《兰亭序》被誉为“天下第一行书”,其笔法精妙,结构严谨,展现了书法艺术的巅峰。'],
],
[
- 'name' => 'Current',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '第三方传入的用户ID', 'description' => '第三方传入的用户ID', 'type' => 'string', 'required' => false, 'example' => 'abc'],
],
[
- 'name' => 'Size',
+ 'name' => 'IsMobile',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '是否是移动端场景', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '返回分页后的素材列表',
- 'description' => '返回分页后的素材列表',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Current' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'description' => '列表对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '素材对象',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者'."\n"
- ."\n",
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-03-18 02:00:00'."\n",
- ],
- 'CreateUser' => [
- 'title' => '创建用户ID',
- 'description' => '创建用户ID',
- 'type' => 'string',
- 'example' => '"1"',
- ],
- 'CreateUserName' => [
- 'title' => '创建用户姓名',
- 'description' => '创建用户姓名',
- 'type' => 'string',
- 'example' => '创建用户名',
- ],
- 'DocKeywords' => [
- 'title' => '文档标签用于分类等、不同keyword之间逗号分割',
- 'description' => '文档标签用于分类等、不同keyword之间逗号分割',
- 'type' => 'array',
- 'items' => [
- 'description' => '关键词',
- 'type' => 'string',
- 'example' => '关键词',
- ],
- ],
- 'DocType' => [
- 'title' => '文档类型,pdf、word、url、image',
- 'description' => '文档类型,pdf、word、url、image',
- 'type' => 'string',
- 'example' => 'pdf',
- ],
- 'ExternalUrl' => [
- 'title' => '外部客户上传的URL,仅用作记录保存',
- 'description' => '外部客户上传的URL,仅用作记录保存',
- 'type' => 'string',
- 'example' => 'https://www.example.com'."\n",
- ],
- 'HtmlContent' => [
- 'description' => '网页内容',
- 'type' => 'string',
- 'example' => '网页内容',
- ],
- 'Id' => [
- 'title' => '主键',
- 'description' => '主键',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '35',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-03-18 02:00:00'."\n",
- ],
- 'PublicUrl' => [
- 'title' => '临时的对外公开的URL',
- 'description' => '临时的对外公开的URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com'."\n",
- ],
- 'ShareAttr' => [
- 'title' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
- 'description' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- 'enum' => [
- '0',
- '1',
- ],
- ],
- 'SrcFrom' => [
- 'title' => '文档来源,user_upload、search、viewpoint',
- 'description' => '文档来源,user_upload、search、viewpoint',
- 'type' => 'string',
- 'example' => 'user_upload',
- ],
- 'Summary' => [
- 'title' => '文档摘要',
- 'description' => '文档摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'TextContent' => [
- 'title' => '解析后的文本内容,对于图片来说为空',
- 'description' => '解析后的文本内容,对于图片来说为空',
- 'type' => 'string',
- 'example' => '文档内容',
- ],
- 'ThumbnailInBase64' => [
- 'title' => '图片文档类型的Base64缩略图',
- 'description' => '图片文档类型的Base64缩略图',
- 'type' => 'string',
- 'example' => 'base64编码的图像二进制数据',
- ],
- 'Title' => [
- 'title' => '文档标题',
- 'description' => '文档标题',
- 'type' => 'string',
- 'example' => '文档标题'."\n"
- ."\n",
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2023-03-18 02:00:00'."\n",
- ],
- 'UpdateUser' => [
- 'title' => '修改用户ID',
- 'description' => '修改用户ID',
- 'type' => 'string',
- 'example' => '"1"',
- ],
- 'UpdateUserName' => [
- 'title' => '修改用户姓名',
- 'description' => '修改用户姓名',
- 'type' => 'string',
- 'example' => '更新用户名',
- ],
- 'Url' => [
- 'title' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除',
- 'description' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除',
- 'type' => 'string',
- 'example' => 'https://www.example.com',
- ],
- 'FileKey' => [
- 'description' => '文件唯一标识',
- 'type' => 'string',
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
- 'FileAttr' => [
- 'description' => '媒体文件属性',
- 'type' => 'object',
- 'properties' => [
- 'Duration' => [
- 'description' => '时长。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '120',
- ],
- 'FileName' => [
- 'description' => '文件名',
- 'type' => 'string',
- 'example' => 'xxx.mp4',
- ],
- 'Width' => [
- 'description' => '视频宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'MimeType' => [
- 'description' => '文件MIME类型',
- 'type' => 'string',
- 'example' => 'image/png',
- ],
- 'FileLength' => [
- 'description' => '文件内容长度',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1048576',
- ],
- 'Height' => [
- 'description' => '视频高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1024',
- ],
- ],
- ],
- ],
+ 'title' => '',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'AppKey' => ['title' => '用于初始化前端组件的AppKey', 'description' => '用于初始化前端组件的AppKey', 'type' => 'string', 'example' => 'S1X5ecouBztZelaQ'],
+ 'Signature' => ['title' => '用于初始化前端组件的Signature', 'description' => '用于初始化前端组件的Signature', 'type' => 'string', 'example' => 'dBBGvT0Toje5887Qw+/IwwMNYfk='],
+ 'PptProcessId' => ['title' => '处理流程ID,用于初始化前端组件-创建PPT作品', 'description' => '处理流程ID,用于初始化前端组件-创建PPT作品', 'type' => 'string', 'example' => '8485143'],
+ 'PptArtifactId' => ['title' => '作品ID,用于作品的编辑', 'description' => '作品ID,用于作品的编辑', 'type' => 'string', 'example' => '53059801'],
+ 'PptArtifactCover' => ['title' => '作品封面图', 'description' => '作品封面图', 'type' => 'string', 'example' => 'http://a.com/xxx.png'],
+ 'ExportTaskId' => ['title' => '导出任务ID', 'description' => '导出任务ID', 'type' => 'string', 'example' => '66b25058-d735-47e5-a534-5da93453d3df'],
+ 'Alert' => ['title' => '额度预警信息', 'type' => 'string', 'example' => '本月版本内的配送额度已经用尽,超额使用将走按量后付费,下个月配送额度将重新下发;请知晓'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => '数据不存在',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Size' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Author\\": \\"作者\\\\n\\\\n\\",\\n \\"CreateTime\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"CreateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"CreateUserName\\": \\"创建用户名\\",\\n \\"DocKeywords\\": [\\n \\"关键词\\"\\n ],\\n \\"DocType\\": \\"pdf\\",\\n \\"ExternalUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"HtmlContent\\": \\"网页内容\\",\\n \\"Id\\": 35,\\n \\"PubTime\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"PublicUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"ShareAttr\\": 1,\\n \\"SrcFrom\\": \\"user_upload\\",\\n \\"Summary\\": \\"摘要\\",\\n \\"TextContent\\": \\"文档内容\\",\\n \\"ThumbnailInBase64\\": \\"base64编码的图像二进制数据\\",\\n \\"Title\\": \\"文档标题\\\\n\\\\n\\",\\n \\"UpdateTime\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"UpdateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"UpdateUserName\\": \\"更新用户名\\",\\n \\"Url\\": \\"https://www.example.com\\",\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FileAttr\\": {\\n \\"Duration\\": 120,\\n \\"FileName\\": \\"xxx.mp4\\",\\n \\"Width\\": 100,\\n \\"MimeType\\": \\"image/png\\",\\n \\"FileLength\\": 1048576,\\n \\"Height\\": 1024\\n }\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Size\\": 10,\\n \\"Success\\": false,\\n \\"Total\\": 100\\n}","type":"json"}]',
- 'title' => '获取素材列表',
- ],
- 'GetCustomText' => [
- 'summary' => '获取自定义文本。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '初始化PPT创建操作',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InitiatePptCreationV2',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"AppKey\\": \\"S1X5ecouBztZelaQ\\",\\n \\"Signature\\": \\"dBBGvT0Toje5887Qw+/IwwMNYfk=\\",\\n \\"PptProcessId\\": \\"8485143\\",\\n \\"PptArtifactId\\": \\"53059801\\",\\n \\"PptArtifactCover\\": \\"http://a.com/xxx.png\\",\\n \\"ExportTaskId\\": \\"66b25058-d735-47e5-a534-5da93453d3df\\",\\n \\"Alert\\": \\"本月版本内的配送额度已经用尽,超额使用将走按量后付费,下个月配送额度将重新下发;请知晓\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'InsertInterveneGlobalReply' => [
+ 'summary' => '设置干预全局回复。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxx_efm'],
],
[
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '63',
- ],
- ],
- [
- 'name' => 'CommodityCode',
+ 'name' => 'ReplyMessagList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '商品code',
- 'description' => '商品code',
- 'type' => 'string',
+ 'title' => '回复内容列表',
+ 'description' => '回复内容列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Message' => ['title' => '回复内容', 'description' => '回复内容', 'type' => 'string', 'required' => false, 'example' => '抱歉,问题我无法回答'],
+ 'ReplyType' => [
+ 'title' => '回复类型',
+ 'description' => '回复类型',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)', 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)', 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)'],
+ 'example' => '全局回复的类型',
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => '商品code',
],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PlainResult<OperationResult>',
+ 'description' => 'PlainResult<OperationResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '内容',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '创建时间',
- ],
- 'CreateUser' => [
- 'title' => '创建用户',
- 'description' => '创建用户',
- 'type' => 'string',
- 'example' => '创建用户',
- ],
- 'Id' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '34',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '修改时间',
- ],
- 'UpdateUser' => [
- 'title' => '修改用户',
- 'description' => '修改用户',
- 'type' => 'string',
- 'example' => '修改用户',
+ 'FailIdList' => [
+ 'title' => '失败的索引id列表',
+ 'description' => '失败的索引id列表',
+ 'type' => 'array',
+ 'items' => ['description' => '错误Id', 'type' => 'string', 'example' => '1234'],
],
+ 'TaskId' => ['title' => '任务id', 'description' => '任务id', 'type' => 'string', 'example' => '4829'],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '插入干预全局回复项',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Content\\": \\"内容\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CreateUser\\": \\"创建用户\\",\\n \\"Id\\": 34,\\n \\"Title\\": \\"标题\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"UpdateUser\\": \\"修改用户\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取自定义文本',
- ],
- 'UpdateCustomText' => [
- 'summary' => '更新自定义文本。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InsertInterveneGlobalReply',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"1234\\"\\n ],\\n \\"TaskId\\": \\"4829\\",\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'InsertInterveneRule' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '96',
- ],
- ],
- [
- 'name' => 'Title',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标题',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'Content',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '内容',
- ],
- ],
- [
- 'name' => 'CommodityCode',
+ 'name' => 'InterveneRuleConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '商品code',
- 'description' => '商品code',
- 'type' => 'string',
+ 'title' => '干预规则配置',
+ 'description' => '干预规则配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'AnswerConfig' => [
+ 'title' => '答案配置',
+ 'description' => '答案配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '答案配置项',
+ 'type' => 'object',
+ 'properties' => [
+ 'AnswerType' => [
+ 'title' => '答案类型',
+ 'description' => '答案类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => ['1-定向回复' => '1-定向回复', ' 0-统一回复' => ' 0-统一回复'],
+ 'example' => '0',
+ ],
+ 'Message' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'required' => false, 'example' => '抱歉我无法回答'],
+ 'Namespace' => [
+ 'title' => '命名空间',
+ 'description' => '命名空间',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => [' namespace_writing_query (写作输入干预)' => ' namespace_writing_query (写作输入干预)', ' namespace_qa_result (问答结果干预)' => ' namespace_qa_result (问答结果干预)', 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', ' namespace_writing_result (写作结果干预)' => ' namespace_writing_result (写作结果干预)'],
+ 'example' => 'namespace_qa_query',
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'EffectConfig' => [
+ 'title' => '生效配置',
+ 'description' => '生效配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'EffectType' => [
+ 'title' => '生效类型',
+ 'description' => '生效类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => ['0-永久生效 ' => '0-永久生效 ', '1-按时间生效' => '1-按时间生效'],
+ 'example' => '0',
+ ],
+ 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2023-03-28 06:04:29'],
+ 'StartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-03-28 06:04:29'],
+ ],
+ 'required' => false,
+ ],
+ 'InterveneConfigList' => [
+ 'title' => '干预配置列表',
+ 'description' => '干预配置列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'required' => false, 'example' => '37249'],
+ 'OperationType' => [
+ 'title' => '操作类型',
+ 'description' => '操作类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => ['0-新建' => '0-新建', ' 1-更新 ' => ' 1-更新 ', '2-删除' => '2-删除'],
+ 'example' => '0',
+ ],
+ 'Query' => ['title' => '干预query配置', 'description' => '干预query配置', 'type' => 'string', 'required' => false, 'example' => '早上好'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ 'InterveneType' => [
+ 'title' => '干预类型',
+ 'description' => '干预类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'enumValueTitles' => ['0-相似问干预项目' => '0-相似问干预项目', ' 2-正则表达式干预项 ' => ' 2-正则表达式干预项 ', '3-关键词库干预项' => '3-关键词库干预项', ' 4-URL干预' => ' 4-URL干预', '1-关键词表达式干预项' => '1-关键词表达式干预项'],
+ 'example' => '0',
+ ],
+ 'NamespaceList' => [
+ 'title' => '命名空间列表',
+ 'description' => '命名空间列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '干预维度',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['namespace_writing_image (智能配图)' => 'namespace_writing_image (智能配图)', 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', 'namespace_qa_article (问答参考)' => 'namespace_qa_article (问答参考)', 'namespace_writing_article (写作参考)' => 'namespace_writing_article (写作参考)', 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)', 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)', 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)'],
+ 'example' => 'namespace_qa_query'."\n"
+ .'(问答输入干预)',
+ ],
+ 'required' => false,
+ ],
+ 'RuleId' => ['title' => '规则Id', 'description' => '规则Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'],
+ 'RuleName' => ['title' => '规则名字', 'description' => '规则名字', 'type' => 'string', 'required' => false, 'example' => 'tf-test-rule'],
+ ],
'required' => false,
- 'example' => '商品code',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PlainResult<InsertInterveneRuleResult>',
+ 'description' => 'PlainResult<InsertInterveneRuleResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '48',
- ],
- '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',
+ 'type' => 'object',
+ 'properties' => [
+ 'RuleId' => ['title' => '规则id', 'description' => '规则id', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'],
+ 'Code' => ['description' => '干预服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '插入干预规则',
+ 'summary' => '插入干预规则。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 48\\n}","type":"json"}]',
- 'title' => '更新自定义文本',
- ],
- 'ListCustomText' => [
- 'summary' => '获取自定义文本列表。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InsertInterveneRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"RuleId\\": 12345,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"DD656AF9-0839-521A-A3D2-F320009F9C87\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListAnalysisTagDetailByTaskId' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -16819,34 +11706,52 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'CommodityCode',
+ 'name' => 'TaskId',
'in' => 'formData',
+ 'schema' => ['title' => '任务ID', 'description' => '任务唯一ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'Categories',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '商品code',
- 'description' => '商品code',
- 'type' => 'string',
+ 'title' => '分类筛选列表',
+ 'description' => '分类筛选列表',
+ 'type' => 'array',
+ 'items' => ['title' => '分类筛选', 'description' => '分类筛选', 'type' => 'string', 'required' => false, 'example' => '分类1'],
'required' => false,
- 'example' => '商品code',
],
],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '下一页标识', 'description' => '下一页标识', 'type' => 'string', 'required' => false, 'example' => 'token-xxxx'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['title' => '每页最大数量', 'description' => '每页最大数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'formData',
+ 'schema' => ['title' => '请求记录数', 'description' => '请求记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'Current',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
],
'responses' => [
200 => [
@@ -16855,343 +11760,354 @@
'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'title' => '标签挖掘分类明细列表',
+ 'description' => '标签挖掘分类明细列表',
'type' => 'array',
'items' => [
- 'description' => '文稿对象',
+ 'title' => '标签挖掘分类明细',
+ 'description' => '标签挖掘分类明细',
'type' => 'object',
'properties' => [
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '内容',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '创建时间',
- ],
- 'CreateUser' => [
- 'title' => '创建用户',
- 'description' => '创建用户',
- 'type' => 'string',
- 'example' => '创建用户',
- ],
- 'Id' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '40',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '修改时间',
- ],
- 'UpdateUser' => [
- 'title' => '修改用户',
- 'description' => '修改用户',
- 'type' => 'string',
- 'example' => '修改用户',
+ 'Id' => ['title' => '数据主键ID', 'description' => '数据主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '112'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xxx'],
+ 'TagTaskType' => ['title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)', 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)', 'type' => 'string', 'example' => 'summaryAndOverview'],
+ 'Content' => ['title' => '标签内容', 'description' => '标签内容', 'type' => 'string', 'example' => 'xxx'],
+ 'ContentTags' => [
+ 'title' => '标签内容列表',
+ 'description' => '标签内容列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '标签值列表',
+ 'description' => '标签值列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'example' => 'xxx'],
+ 'SummaryOverview' => ['title' => '总结概括', 'description' => '总结概括', 'type' => 'string', 'example' => 'xxx'],
+ 'Tags' => [
+ 'title' => '标签值列表',
+ 'description' => '标签值列表',
+ 'type' => 'array',
+ 'items' => ['title' => '标签值', 'description' => '标签值', 'type' => 'string', 'example' => '标签值列表'],
+ ],
+ ],
+ ],
],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ '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'],
+ 'NextToken' => ['title' => '下一页标识', 'description' => '下一页标识', 'type' => 'string', 'example' => 'token-xxxx'],
+ 'MaxResults' => ['title' => '每页最大数量', 'description' => '每页最大数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Content\\": \\"内容\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CreateUser\\": \\"创建用户\\",\\n \\"Id\\": 40,\\n \\"Title\\": \\"标题\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"UpdateUser\\": \\"修改用户\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取自定义文本列表',
- ],
- 'SaveCustomText' => [
- 'summary' => '保存自定义文本。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '根据任务ID获取标签分析明细列表',
+ 'summary' => '分页获取企业VOC分析任务明细列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 112,\\n \\"TaskId\\": \\"xxx\\",\\n \\"TagTaskType\\": \\"summaryAndOverview\\",\\n \\"Content\\": \\"xxx\\",\\n \\"ContentTags\\": [\\n {\\n \\"TagName\\": \\"xxx\\",\\n \\"SummaryOverview\\": \\"xxx\\",\\n \\"Tags\\": [\\n \\"标签值列表\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"NextToken\\": \\"token-xxxx\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 10\\n}","type":"json"}]',
+ ],
+ 'ListAsyncTasks' => [
+ 'summary' => '获取异步任务列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'],
],
[
- 'name' => 'Title',
+ 'name' => 'TaskName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务名称精确查询', 'description' => '任务名称精确查询', 'type' => 'string', 'required' => false, 'example' => '任务名称'],
+ ],
+ [
+ 'name' => 'TaskCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务Code精确查询', 'description' => '任务Code精确查询', 'type' => 'string', 'required' => false, 'example' => 'MaterialDocumentUpload'],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务类型精确查询', 'description' => '任务类型精确查询', 'type' => 'string', 'required' => false, 'example' => '暂无'],
+ ],
+ [
+ 'name' => 'TaskStatus',
'in' => 'formData',
'schema' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
+ 'title' => '任务状态精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
+ 'description' => '任务状态精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '标题',
+ 'example' => '1',
+ 'enum' => ['0', '1', '2', '3', '4', '5', '6'],
],
],
[
- 'name' => 'Content',
+ 'name' => 'TaskStatusList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
+ 'title' => '任务状态列表精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
+ 'description' => '任务状态列表精确查询 (0: 待执行, 1: 执行中, 2: 成功, 3: 暂停, 4: 失败可重试, 5: 失败不可重试, 6: 取消)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '任务状态',
+ 'description' => '任务状态',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'required' => false,
+ 'example' => '1',
+ 'enum' => ['0', '1', '2', '3', '4', '5', '6'],
+ ],
'required' => false,
- 'example' => '内容',
],
],
[
- 'name' => 'CommodityCode',
+ 'name' => 'TaskTypeList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '商品code',
- 'description' => '商品code',
- 'type' => 'string',
+ 'title' => '任务类型列表精确查询',
+ 'description' => '任务类型列表精确查询',
+ 'type' => 'array',
+ 'items' => ['title' => '任务分类', 'description' => '任务分类', 'type' => 'string', 'required' => false, 'example' => 'test'],
'required' => false,
- 'example' => '商品code',
],
],
+ [
+ 'name' => 'CreateTimeStart',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务创建时间 开始查询,格式为:YYYY-MM-DD HH:mm:ss', 'description' => '任务创建时间 开始查询,格式为:YYYY-MM-DD HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11'],
+ ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务创建时间 结束查询,格式为:YYYY-MM-DD HH:mm:ss', 'description' => '任务创建时间 结束查询,格式为:YYYY-MM-DD HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'],
+ ],
+ [
+ 'name' => 'Current',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'formData',
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PageResult<AsyncTask>',
+ 'description' => 'PageResult<AsyncTask>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Current' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '5',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'description' => '返回的数据内容。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务列表。',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2020-12-23 15:41:58'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '1111'],
+ 'Id' => ['description' => '任务主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TaskCode' => ['title' => '任务标识,标识为哪一个任务', 'description' => '任务标识,标识为哪一个任务', 'type' => 'string', 'example' => 'MaterialDocumentUpload'],
+ 'TaskDefinition' => ['title' => '可选的任务定义配置,JSON格式,这里的参数会覆盖系统配置的定义 详见:com.alibaba.tongyi.enterprise.aimiaobi.asynctask.entities.AsyncTaskDefinition', 'description' => '可选的任务定义配置,JSON格式,这里的参数会覆盖系统配置的定义', 'type' => 'string', 'example' => '{}'],
+ 'TaskEndTime' => ['title' => '任务实际结束时间', 'description' => '任务实际结束时间', 'type' => 'string', 'example' => '2023-03-09 00:00:00'],
+ 'TaskErrorMessage' => ['title' => '任务执行错误消息-供客户端查看', 'description' => '任务执行错误消息-供客户端查看', 'type' => 'string', 'example' => '系统内部错误'],
+ 'TaskExecuteTime' => ['title' => '任务执行时间,只会轮询任务到期可执行的任务、为空表示立即执行', 'description' => '任务执行时间,只会轮询任务到期可执行的任务、为空表示立即执行', 'type' => 'string', 'example' => '2023-10-14 14:30:00'],
+ 'TaskId' => ['title' => '唯一任务ID,作用等价于id', 'description' => '唯一任务ID,作用等价于id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskInnerErrorMessage' => ['title' => '任务内部的执行错误消息,一些异常栈、内部线程栈等敏感信息打印在这里', 'description' => '任务内部的执行错误消息,一些异常栈、内部线程栈等敏感信息打印在这里', 'type' => 'string', 'example' => '系统错误'],
+ 'TaskIntermediateResult' => ['title' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续', 'description' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续', 'type' => 'string', 'example' => '{}'],
+ 'TaskName' => ['title' => '任务名', 'description' => '任务名', 'type' => 'string', 'example' => '任务名'],
+ 'TaskParam' => ['title' => '任务执行输入参数,JSON格式', 'description' => '任务执行输入参数,JSON格式', 'type' => 'string', 'example' => '{}'],
+ 'TaskProgressMessage' => ['title' => '任务执行进度信息', 'description' => '任务执行进度信息', 'type' => 'string', 'example' => '{}'],
+ 'TaskResult' => ['title' => '任务执行结果信息', 'description' => '任务执行结果信息', 'type' => 'string', 'example' => '{}'],
+ 'TaskRetryCount' => ['title' => '任务已经重试的次数', 'description' => '任务已经重试的次数', 'type' => 'string', 'example' => '1'],
+ 'TaskStartTime' => ['title' => '任务实际开始时间', 'description' => '任务实际开始时间', 'type' => 'string', 'example' => '2023-03-20 10:53:00'],
+ 'TaskStatus' => ['title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'TaskType' => ['title' => '任务分类,多个任务分类一逗号分隔', 'description' => '任务分类,多个任务分类一逗号分隔', 'type' => 'string', 'example' => 'test'],
+ 'UpdateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2023-02-16 10:29:16'],
+ 'UpdateUser' => ['title' => '更新者', 'description' => '更新者', 'type' => 'string', 'example' => '111'],
+ ],
+ ],
+ ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'],
+ 'Size' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取异步任务列表',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": 5,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '保存自定义文本',
- ],
- 'DeleteCustomText' => [
- 'summary' => '删除自定义文本。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAsyncTasks'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAsyncTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": \\"2020-12-23 15:41:58\\",\\n \\"CreateUser\\": \\"1111\\",\\n \\"Id\\": 1,\\n \\"TaskCode\\": \\"MaterialDocumentUpload\\",\\n \\"TaskDefinition\\": \\"{}\\",\\n \\"TaskEndTime\\": \\"2023-03-09 00:00:00\\",\\n \\"TaskErrorMessage\\": \\"系统内部错误\\",\\n \\"TaskExecuteTime\\": \\"2023-10-14 14:30:00\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskInnerErrorMessage\\": \\"系统错误\\",\\n \\"TaskIntermediateResult\\": \\"{}\\",\\n \\"TaskName\\": \\"任务名\\",\\n \\"TaskParam\\": \\"{}\\",\\n \\"TaskProgressMessage\\": \\"{}\\",\\n \\"TaskResult\\": \\"{}\\",\\n \\"TaskRetryCount\\": \\"1\\",\\n \\"TaskStartTime\\": \\"2023-03-20 10:53:00\\",\\n \\"TaskStatus\\": 1,\\n \\"TaskType\\": \\"test\\",\\n \\"UpdateTime\\": \\"2023-02-16 10:29:16\\",\\n \\"UpdateUser\\": \\"111\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 20\\n}","type":"json"}]',
+ ],
+ 'ListAuditContentErrorTypes' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'Id',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '85',
- ],
+ 'schema' => ['title' => '最大记录数', 'description' => '最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2000', 'minimum' => '0', 'example' => '100'],
],
[
- 'name' => 'CommodityCode',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '商品Code',
- 'description' => '商品code',
- 'type' => 'string',
- 'required' => false,
- 'example' => '商品code',
- ],
+ 'schema' => ['title' => '下一页Token', 'description' => '下一页Token', 'type' => 'string', 'required' => false, 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '是否删除成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'title' => '审核维度列表',
+ 'description' => '审核维度列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '主审核维度',
+ 'description' => '主审核维度',
+ 'type' => 'object',
+ 'properties' => [
+ 'MajorClassCode' => ['title' => '主审核维度Code', 'description' => '主审核维度Code', 'type' => 'string', 'example' => 'ContentAccuracy'],
+ 'SubClasses' => [
+ 'title' => '子审核维度列表',
+ 'description' => '子审核维度列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '子审核维度',
+ 'description' => '子审核维度',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClassCode' => ['title' => '子审核维度Code', 'description' => '子审核维度Code', 'type' => 'string', 'example' => 'PunctuationError'],
+ 'ClassName' => ['title' => '子审核维度名称', 'description' => '子审核维度名称', 'type' => 'string', 'example' => '标点符号错误'],
+ ],
+ ],
+ ],
+ 'MajorClassName' => ['title' => '子审核维度名称', 'description' => '子审核维度名称', 'type' => 'string', 'example' => '内容准确性'],
+ ],
+ ],
],
+ 'NextToken' => ['title' => '下一页Token', 'description' => '下一页Token', 'type' => 'string', 'example' => '下一页的token'],
+ 'TotalCount' => ['description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'MaxResults' => ['title' => '当前返回的最大记录数', 'description' => '当前返回的最大记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除自定义文本',
- ],
- 'DocumentExtraction' => [
- 'summary' => '从链接中提取文档内容。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取审校维度列表',
+ 'summary' => '获取审核维度列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAuditContentErrorTypes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"MajorClassCode\\": \\"ContentAccuracy\\",\\n \\"SubClasses\\": [\\n {\\n \\"ClassCode\\": \\"PunctuationError\\",\\n \\"ClassName\\": \\"标点符号错误\\"\\n }\\n ],\\n \\"MajorClassName\\": \\"内容准确性\\"\\n }\\n ],\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"TotalCount\\": 20,\\n \\"MaxResults\\": 20\\n}","type":"json"}]',
+ ],
+ 'ListAuditTerms' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -17199,171 +12115,101 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Urls',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '待提取的链接列表',
- 'description' => '待提取的链接列表',
- 'type' => 'array',
- 'items' => [
- 'title' => 'URL链接',
- 'description' => 'URL链接,URL长度不能超过2048',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/',
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '下一页的Token', 'description' => '下一页的Token', 'type' => 'string', 'required' => false, 'example' => 'XXXX'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '返回的最大记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'TermsName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '词典名称。可选。不填默认 Default', 'description' => '词典名称。可选。不填默认 Default', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'array',
'items' => [
- 'description' => '文档对象',
+ 'title' => '是否删除成功',
+ 'description' => '是否删除成功',
'type' => 'object',
'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => '8df2d69d63a247b6b52ff455b2d426b6',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-05-14 08:54:33',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '新闻来源',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
+ 'Id' => ['title' => '任务主键ID', 'description' => '任务主键ID', 'type' => 'string', 'example' => '1'],
+ 'Keyword' => ['title' => '关键词', 'description' => '关键词', 'type' => 'string', 'example' => '龘'],
+ 'SuggestWord' => ['title' => '建议词', 'description' => '建议词', 'type' => 'string', 'example' => '龘(dá)'],
+ 'TermsDesc' => ['title' => '审核依据', 'description' => '审核依据', 'type' => 'string', 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。'],
+ 'ExceptionWord' => [
+ 'title' => '例外语句',
+ 'description' => '例外语句',
+ 'type' => 'array',
+ 'items' => ['title' => '词典名称', 'description' => '词典名称', 'type' => 'string'],
],
+ 'TermsName' => ['title' => '词典名称', 'description' => '词典名称', 'type' => 'string'],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '77'],
+ 'NextToken' => ['title' => '下一页的Token', 'description' => '下一页的Token', 'type' => 'string', 'example' => 'x\'x\'x'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '58'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义词库记录',
+ 'summary' => '获取词库列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-08-15T05:32:39.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"8df2d69d63a247b6b52ff455b2d426b6\\",\\n \\"PubTime\\": \\"2024-05-14 08:54:33\\",\\n \\"Source\\": \\"新闻来源\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '文档提取',
- ],
- 'GetClipsBuildInResource' => [
- 'summary' => '获得智能混剪内置资源',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"Keyword\\": \\"龘\\",\\n \\"SuggestWord\\": \\"龘(dá)\\",\\n \\"TermsDesc\\": \\"龙行龘龘出自四库本《玉篇》23龙部第8字,文字释义为群龙腾飞的样子,昂扬而热烈。\\",\\n \\"ExceptionWord\\": [\\n \\"\\"\\n ],\\n \\"TermsName\\": \\"\\"\\n }\\n ],\\n \\"MaxResults\\": 77,\\n \\"NextToken\\": \\"x\'x\'x\\",\\n \\"TotalCount\\": 58\\n}","type":"json"}]',
+ ],
+ 'ListAutoClipsTask' => [
+ 'summary' => '列出智能混剪任务列表',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -17371,33 +12217,62 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '百炼业务空间Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-az2gglkjauwnnhpq',
- ],
+ 'schema' => ['description' => '百炼业务空间', 'type' => 'string', 'required' => false, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'ResourceType',
+ 'name' => 'TaskName',
'in' => 'formData',
- 'schema' => [
- 'description' => '资源类型。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0 - 音色'."\n"
- .'1- 背景音',
- ],
+ 'schema' => ['description' => '任务名称', 'type' => 'string', 'required' => false, 'example' => 'task001'],
+ ],
+ [
+ 'name' => 'TaskType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务类型', 'type' => 'string', 'required' => false, 'example' => 'type001'],
+ ],
+ [
+ 'name' => 'TaskStatus',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务状态', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
+ ],
+ [
+ 'name' => 'CreateTimeStart',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务开始时间', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11'],
+ ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'formData',
+ 'schema' => ['description' => '任务结束时间', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'],
+ ],
+ [
+ 'name' => 'Current',
+ 'in' => 'formData',
+ 'schema' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'formData',
+ 'schema' => ['description' => '每页条数:默认 10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Skip',
+ 'in' => 'formData',
+ 'schema' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '废弃', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
@@ -17407,82 +12282,69 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Code' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'MaxResults' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'],
+ 'NextToken' => ['description' => '废弃', 'type' => 'string', 'example' => 'null'],
+ 'TotalCount' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
'Data' => [
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'ResourceType' => [
- 'description' => '资源类型。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0 - 音色'."\n"
- .'1- 背景音',
- ],
- 'ResourceList' => [
- 'description' => '资源列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '资源列表',
- 'type' => 'string',
- 'example' => '轻快',
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskName' => ['description' => '任务名称', 'type' => 'string', 'example' => '任务名称'],
+ 'TaskType' => ['description' => '任务类型', 'type' => 'string', 'example' => 'type001'],
+ 'TaskStatus' => ['description' => '任务状态', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'TaskStep' => ['description' => 'upload', 'type' => 'string', 'example' => 'upload'."\n"
+ .'clips'."\n"
+ .'generate'],
+ 'CreateTimeStart' => ['description' => '起始创建时间。', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回结果消息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '智能混剪任务列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"ResourceType\\": 0,\\n \\"ResourceList\\": [\\n \\"轻快\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取智能混剪内置资源',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAutoClipsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"null\\",\\n \\"TotalCount\\": 0,\\n \\"Current\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 20,\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"TaskType\\": \\"type001\\",\\n \\"TaskStatus\\": 0,\\n \\"TaskStep\\": \\"upload\\\\nclips\\\\ngenerate\\",\\n \\"CreateTimeStart\\": \\"2023-03-18 02:00:00\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
],
- 'AsyncCreateClipsTimeLine' => [
- 'summary' => '智能剪辑timeline',
+ 'ListBiddingDoc' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -17490,71 +12352,57 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
- ],
+ 'schema' => ['description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'ProcessPrompt',
+ 'name' => 'TaskName',
'in' => 'formData',
- 'schema' => [
- 'description' => '处理用prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '口播内容是乌镇旅游宣传广告,口播内容时长约为1分钟,开头要描述乌镇是千年文化传承的江南水乡,之后要体现乌镇的传统手工艺、美食和美景,最后要号召大家来乌镇旅游',
- ],
+ 'schema' => ['description' => '任务名称定义', 'type' => 'string', 'required' => false, 'example' => '任务名称'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'TaskStatus',
'in' => 'formData',
- 'schema' => [
- 'description' => '[百炼工作空间Id](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['description' => '任务状态', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0-waiting、1-running、2-success、3-pause、4-fail'],
],
[
- 'name' => 'CustomContent',
+ 'name' => 'CreateTimeStart',
'in' => 'formData',
- 'schema' => [
- 'description' => '自定义口播内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义口播内容',
- ],
+ 'schema' => ['description' => '起始创建时间,时间戳形式。', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11'],
],
[
- 'name' => 'NoRefVideo',
+ 'name' => 'CreateTimeEnd',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否开启模仿能力',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '默认开启',
- ],
+ 'schema' => ['description' => '截止创建时间,时间戳形式。', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'],
],
[
- 'name' => 'AdditionalContent',
+ 'name' => 'Current',
'in' => 'formData',
- 'schema' => [
- 'description' => '素材附加信息,有助于口播文案的生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => '素材附加信息',
- ],
+ 'schema' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'formData',
+ 'schema' => ['description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Skip',
+ 'in' => 'formData',
+ 'schema' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '废弃', 'type' => 'string', 'required' => false, 'example' => 'null'],
],
],
'responses' => [
@@ -17564,652 +12412,440 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'MaxResults' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'],
+ 'NextToken' => ['description' => '废弃', 'type' => 'string', 'example' => 'null'],
+ 'TotalCount' => ['description' => '废弃', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'Data' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'description' => '返回数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskName' => ['description' => '任务名称', 'type' => 'string', 'example' => '任务名称'],
+ 'TaskStatus' => ['description' => '任务状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'CreateTimeStart' => ['description' => '创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"],
+ 'TaskStep' => ['description' => '任务阶段', 'type' => 'string', 'example' => 'analysis'."\n"
+ .'writing'],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '创建剪辑口播时间线',
- ],
- 'AsyncEditTimeline' => [
- 'summary' => '编辑剪辑任务的timeline',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '列出标书写作任务',
+ 'summary' => '获得标书写作任务列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"null\\",\\n \\"TotalCount\\": 0,\\n \\"Current\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"TaskStatus\\": 1,\\n \\"CreateTimeStart\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"TaskStep\\": \\"analysis\\\\nwriting\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListBuildConfigs' => [
+ 'summary' => '获取系统自定义预设,用于创作文章 -> 直接生成中的内置选项。例如:写作文体、文章篇幅、输出语言、生成文章篇数等选项。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'],
+ ],
+ [
+ 'name' => 'Type',
'in' => 'formData',
'schema' => [
- 'description' => '任务唯一标识',
+ 'title' => '政务和传媒类别,media:传媒,government:政务',
+ 'description' => '政务和传媒类别,media:传媒;government:政务',
'type' => 'string',
- 'required' => true,
- 'example' => '0dbf1055f8a2475d99904c3b76a0ffba',
+ 'required' => false,
+ 'enumValueTitles' => ['market' => '营销文稿', 'government' => '政务文稿', 'media' => '传媒文稿', 'office' => '办公文稿'],
+ 'example' => 'media',
+ 'default' => 'media',
+ 'enum' => ['media', 'government', 'custom'],
],
],
[
- 'name' => 'Timelines',
- 'in' => 'formData',
- 'style' => 'json',
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'description' => '成功',
'schema' => [
- 'description' => '剪辑时间线数组结构',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Clips' => [
- 'description' => '剪辑片段数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '剪辑片段',
- 'type' => 'object',
- 'properties' => [
- 'OutEx' => [
- 'description' => '片段结束时间(毫秒)',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '3.66',
- ],
- 'ClipId' => [
- 'description' => '片段ID。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123jjdax'."\n"
- .'新增可为空',
- ],
- 'VideoId' => [
- 'description' => '视频ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7036227ae3ab71efbb4a6733a68f0102'."\n"
- .'不可为空',
- ],
- 'VideoName' => [
- 'description' => '视频名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123.mp4'."\n"
- .'不可为空',
- ],
- 'In' => [
- 'description' => '开始时间(妙)已经废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0'."\n"
- .'不可为空',
- ],
- 'ContentInner' => [
- 'description' => '口播文案分段',
- 'type' => 'string',
- 'required' => false,
- 'example' => '口播文案分段'."\n"
- .'不可为空',
- ],
- 'InEx' => [
- 'description' => '片段开始时间(毫秒)',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.45',
- ],
- 'Out' => [
- 'description' => '结束时间(妙)已经废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5'."\n"
- .'不可为空',
+ 'title' => 'PlainResult<List<PromptBuildConfigQueryDO>>',
+ 'description' => 'PlainResult<List<PromptBuildConfigQueryDO>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '200'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'BuildIn' => ['title' => '是否为内置', 'description' => '是否为内置', 'type' => 'boolean', 'example' => 'true'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-04-11 06:14:07'],
+ 'CreateUser' => ['title' => '创建用户', 'description' => '创建用户', 'type' => 'string', 'example' => '1'],
+ 'Id' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '主键ID,内置配置(buildIn=true)无该字段'],
+ 'Keywords' => [
+ 'title' => '标签可选的值列表',
+ 'description' => '标签可选的值列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '标签可选的值定义',
+ 'description' => '标签可选的值定义',
+ 'type' => 'object',
+ 'properties' => [
+ 'Description' => ['title' => '预设标签的描述', 'description' => '预设标签的描述', 'type' => 'string', 'example' => '新闻内容'],
+ 'Key' => ['title' => '预设标签的KEY', 'description' => '预设标签的KEY', 'type' => 'string', 'example' => '新闻内容'],
+ ],
],
],
- 'required' => false,
+ 'Tag' => ['title' => '标签key值', 'description' => '标签key值', 'type' => 'string', 'example' => 'writingStyle'],
+ 'TagDescription' => ['title' => '标签描述', 'description' => '标签描述', 'type' => 'string', 'example' => '文体'],
+ 'Type' => ['title' => '区分政务和传媒,media:传媒,government:政务', 'description' => '区分政务和传媒-media:传媒;government:政务', 'type' => 'string', 'example' => 'media'],
+ 'UpdateTime' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2023-04-11 06:14:07'."\n"],
+ 'UpdateUser' => ['title' => '更新用户', 'description' => '更新用户', 'type' => 'string', 'example' => '1'],
],
- 'required' => true,
- ],
- 'TimelineId' => [
- 'description' => '时间线Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'sdfjhks'."\n"
- .'新增可为空',
],
],
- 'required' => false,
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'Success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
- 'required' => true,
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取系统自定义预设',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-18T07:54:44.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListBuildConfigs'],
+ ],
+ ],
+ 'ramActions' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '[百炼业务空间Id](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-az2gglkjauwnnhpq',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListBuildConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"BuildIn\\": true,\\n \\"CreateTime\\": \\"2023-04-11 06:14:07\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"Id\\": 0,\\n \\"Keywords\\": [\\n {\\n \\"Description\\": \\"新闻内容\\",\\n \\"Key\\": \\"新闻内容\\"\\n }\\n ],\\n \\"Tag\\": \\"writingStyle\\",\\n \\"TagDescription\\": \\"文体\\",\\n \\"Type\\": \\"media\\",\\n \\"UpdateTime\\": \\"2023-04-11 06:14:07\\\\n\\",\\n \\"UpdateUser\\": \\"1\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListCustomText' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'AutoClips',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'CommodityCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否开启自动调整能力',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '商品code', 'description' => '商品code', 'type' => 'string', 'required' => false, 'example' => '商品code'],
],
],
'responses' => [
200 => [
'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' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
+ 'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '唯一任务ID',
- 'type' => 'string',
- 'example' => '51e4efd1908242eb93ca9bbb7fc4359d',
- ],
- 'Message' => [
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => '一些建议信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文稿对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '内容'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '创建时间'],
+ 'CreateUser' => ['title' => '创建用户', 'description' => '创建用户', 'type' => 'string', 'example' => '创建用户'],
+ 'Id' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '40'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '修改时间'],
+ 'UpdateUser' => ['title' => '修改用户', 'description' => '修改用户', 'type' => 'string', 'example' => '修改用户'],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义文本列表',
+ 'summary' => '获取自定义文本列表。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"51e4efd1908242eb93ca9bbb7fc4359d\\",\\n \\"Message\\": \\"一些建议信息\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '编辑剪辑口播时间线',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Content\\": \\"内容\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CreateUser\\": \\"创建用户\\",\\n \\"Id\\": 40,\\n \\"Title\\": \\"标题\\",\\n \\"UpdateTime\\": \\"修改时间\\",\\n \\"UpdateUser\\": \\"修改用户\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'AsyncUploadVideo' => [
- 'summary' => '上传剪辑素材',
+ 'ListCustomViewPoints' => [
+ 'summary' => '自定义视角列表。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'SourceVideos',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '剪辑素材结构',
- 'description' => '剪辑素材结构',
- 'type' => 'array',
- 'items' => [
- 'title' => '剪辑素材结构',
- 'description' => '剪辑素材结构',
- 'type' => 'object',
- 'properties' => [
- 'VideoName' => [
- 'title' => '视频名称'."\n",
- 'description' => '视频名称'."\n",
- 'type' => 'string',
- 'required' => true,
- 'example' => '123.mp4',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址。',
- 'description' => '视频地址。',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'http://123.mp4'."\n"
- .'目前该接口只进行视频理解额和分析,并没有对文件进行转存。请保证视频地址在任务执行期间有效。',
- ],
- 'VideoExtraInfo' => [
- 'title' => '视频额外描述',
- 'description' => '视频额外描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '视频中有一个房子',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'AnlysisPrompt',
+ 'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频理解prompt',
- 'description' => '视频理解prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '重点理解视频中的风景信息',
- ],
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => false, 'example' => '热榜主题'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'Attitude',
'in' => 'formData',
- 'schema' => [
- 'title' => '[百炼工作空间Id](~~2782167~~)',
- 'description' => '[百炼工作空间Id](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxxx',
- ],
+ 'schema' => ['title' => '筛选对应观点', 'description' => '筛选对应观点', 'type' => 'string', 'required' => false, 'example' => '观点'],
],
[
- 'name' => 'ReferenceVideo',
+ 'name' => 'Attitudes',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '参考视频信息',
- 'description' => '参考视频信息',
- 'type' => 'object',
- 'properties' => [
- 'VideoName' => [
- 'title' => '参考视频名字',
- 'description' => '参考视频名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'refvideo.mp4',
- ],
- 'VideoUrl' => [
- 'title' => '视频地址。',
- 'description' => '视频地址。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/d71e_208334498220521996_51298e0a909d457693166eb883768c7a',
- ],
- 'VideoExtraInfo' => [
- 'title' => '视频理解附加信息',
- 'description' => '视频理解附加信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '手机cpu采用3纳米技术',
- ],
- ],
+ 'title' => '筛选观点列表',
+ 'description' => '筛选观点列表',
+ 'type' => 'array',
+ 'items' => ['title' => '观点', 'description' => '观点', 'type' => 'string', 'required' => false, 'example' => '观点'."\n"
+ .' * '],
'required' => false,
+ 'example' => '观点'."\n"
+ .' * ',
],
],
[
- 'name' => 'SplitInterval',
+ 'name' => 'CustomViewPointId',
'in' => 'formData',
- 'schema' => [
- 'title' => '视频理解镜头时间间隔',
- 'description' => '视频理解镜头时间间隔',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '默认1',
- ],
+ 'schema' => ['title' => '自定义视角ID', 'description' => '自定义视角ID', 'type' => 'string', 'required' => false, 'example' => '461591f4880747f890702c1b90494d1a'],
],
[
- 'name' => 'VideoRoles',
+ 'name' => 'CustomViewPointIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '角色人脸信息',
- 'description' => '角色人脸信息',
+ 'title' => '自定义视角ID列表',
+ 'description' => '自定义视角ID列表',
'type' => 'array',
- 'items' => [
- 'title' => '角色名字',
- 'description' => '角色名字',
- 'type' => 'object',
- 'properties' => [
- 'RoleName' => [
- 'title' => '角色名字',
- 'description' => '角色名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '李晓明',
- ],
- 'RoleInfo' => [
- 'title' => '角色信息',
- 'description' => '角色信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => '李晓明是一位警察',
- ],
- 'RoleUrls' => [
- 'title' => '角色照片地址',
- 'description' => '角色照片地址',
- 'type' => 'array',
- 'items' => [
- 'title' => '角色图片文件信息',
- 'description' => '角色图片文件信息',
- 'type' => 'object',
- 'properties' => [
- 'RoleFileName' => [
- 'title' => '角色面部图片文件名字',
- 'description' => '角色面部图片文件名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '王小明.jpeg',
- ],
- 'RoleFileUrl' => [
- 'title' => '角色面部图片公网地址',
- 'description' => '角色面部图片公网地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/xxx.jpeg',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'FaceIdentitySimilarityMinScore',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '人物识别相似度阈值',
- 'description' => '人物识别相似度阈值',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.7',
- ],
- ],
- [
- 'name' => 'VideoShotFaceIdentityCount',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量',
- 'description' => '人物匹配时,单镜头(分镜),参与匹配的抽帧(图片)数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
- ],
- [
- 'name' => 'RemoveSubtitle',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '去除素材字幕',
- 'description' => '去除素材字幕',
- 'type' => 'boolean',
+ 'items' => ['title' => '自定义视角ID', 'description' => '自定义视角ID', 'type' => 'string', 'required' => false, 'example' => 'bb1a5426a9c34e3e8165e7939032bddd'],
'required' => false,
+ 'example' => '7ece3d1212e04c9ca716ae2486228f3f',
],
],
[
- 'name' => 'TaskName',
+ 'name' => 'TopicId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务名称精确查询',
- 'description' => '任务名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task001',
- ],
+ 'schema' => ['title' => '话题ID', 'description' => '话题ID', 'type' => 'string', 'required' => false, 'example' => '1d20ed14db0840efb1c7eaaf4d46352b'],
],
[
- 'name' => 'TaskType',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)',
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'type001',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
],
[
- 'name' => 'AdaptiveThreshold',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '分镜阈值,越小分镜越敏感,取值 1·10,默认是 3',
- 'description' => '分镜阈值,越小分镜越敏感,取值1·10,默认是3',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '3.0',
- ],
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '52'],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PageResult2',
+ 'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0',
- ],
- 'Code' => [
- 'title' => '请求返回Code',
- 'description' => '请求返回Code',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'VideoInfos' => [
- 'title' => '视频信息',
- 'description' => '视频信息',
- 'type' => 'array',
- 'items' => [
- 'title' => '视频信息',
- 'description' => '视频信息',
- 'type' => 'object',
- 'properties' => [
- 'VideoId' => [
- 'title' => '视频Id',
- 'description' => '视频Id',
- 'type' => 'string',
- 'example' => '60616fad41b171f0bb4b4531948c0102',
- ],
- 'VideoName' => [
- 'title' => '视频名称'."\n",
- 'description' => '视频名称'."\n",
- 'type' => 'string',
- 'example' => '123.mp4',
- ],
- 'VideoUrl' => [
- 'title' => '视频URL',
- 'description' => '视频URL',
- 'type' => 'string',
- 'example' => 'http://123.mp4',
- ],
- 'VideoExtraInfo' => [
- 'title' => '视频额外信息',
- 'description' => '视频额外信息',
- 'type' => 'string',
- 'example' => '视频中有一个房子',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AsyncTaskId' => ['title' => '异步任务ID(分析该自定义视角的任务)', 'description' => '异步任务ID(分析该自定义视角的任务)', 'type' => 'string', 'example' => '2323ac73e174428a98c91097a59c67e0'],
+ 'Attitude' => ['title' => '观点', 'description' => '观点', 'type' => 'string', 'example' => '观点'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-08-15 16:18:59'],
+ 'CreateUser' => ['title' => '创建用户ID', 'description' => '创建用户ID', 'type' => 'string', 'example' => '1'],
+ 'Id' => ['title' => '自定义视角ID', 'description' => '自定义视角ID', 'type' => 'string', 'example' => '709806dd051042d5ab9de8bdbb3a64ca'],
+ 'Status' => [
+ 'title' => '任务执行状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'description' => '任务执行状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
+ 'type' => 'string',
+ 'example' => 'RUNNING',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
+ ],
+ 'TaskErrorMessage' => ['title' => '任务执行错误信息', 'description' => '任务执行错误信息', 'type' => 'string', 'example' => '参数校验失败'],
+ 'TaskStatus' => ['title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '73'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取自定义视角列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListCustomViewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"VideoInfos\\": [\\n {\\n \\"VideoId\\": \\"60616fad41b171f0bb4b4531948c0102\\",\\n \\"VideoName\\": \\"123.mp4\\",\\n \\"VideoUrl\\": \\"http://123.mp4\\",\\n \\"VideoExtraInfo\\": \\"视频中有一个房子\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '异步上传视频剪辑素材',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"AsyncTaskId\\": \\"2323ac73e174428a98c91097a59c67e0\\",\\n \\"Attitude\\": \\"观点\\",\\n \\"CreateTime\\": \\"2024-08-15 16:18:59\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"Id\\": \\"709806dd051042d5ab9de8bdbb3a64ca\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"TaskErrorMessage\\": \\"参数校验失败\\",\\n \\"TaskStatus\\": 1,\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 60,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 73\\n}","type":"json"}]',
],
- 'GetAutoClipsTaskInfo' => [
- 'summary' => '获得剪辑任务状态',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListDataPermissions' => [
+ 'summary' => '权限-列表'."\n"
+ .'- 数据集',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -18217,1063 +12853,379 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0dbf1055f8a2475d99904c3b76a0ffba',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'DataType',
'in' => 'formData',
- 'schema' => [
- 'description' => '[工作空间](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '百炼工作空间Id',
- ],
+ 'schema' => ['title' => '', 'description' => '数据类型:'."\n"
+ .'- dataset:数据集', 'type' => 'string', 'required' => false, 'example' => 'dataset'],
],
[
- 'name' => 'ShowResourceInfo',
+ 'name' => 'DataId',
'in' => 'formData',
- 'schema' => [
- 'description' => '展示视频素材信息',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '', 'description' => '数据权限数据唯一标识'."\n"
+ .'- dataset:SystemSearch.QuarkCommonNews', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch.QuarkCommonNews'],
],
[
- 'name' => 'ShowAnalysisResults',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '展示视频理解结果',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页:默认1', 'description' => '当前页:默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
],
'responses' => [
200 => [
+ 'description' => '成功',
'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' => 'successful',
- ],
'Data' => [
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => 'e5a1a59c82d0454fad6454e8a04d0093',
- ],
- 'Step' => [
- 'description' => '当前所处状态',
- 'type' => 'string',
- 'example' => 'clips',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- ],
- 'Content' => [
- 'description' => '全部口播内容',
- 'type' => 'string',
- 'example' => '口播内容',
- ],
- 'Timelines' => [
- 'description' => '口播时间线数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '口播时间线',
- 'type' => 'object',
- 'properties' => [
- 'TimelineId' => [
- 'description' => '时间线id',
- 'type' => 'string',
- 'example' => '20774ebd9abc71ef80486632b68f0102',
- ],
- 'Content' => [
- 'description' => '口播内容',
- 'type' => 'string',
- 'example' => '口播内容',
- ],
- 'Clips' => [
- 'description' => '剪辑片段数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '剪辑片段',
- 'type' => 'object',
- 'properties' => [
- 'ClipId' => [
- 'description' => '剪辑Id',
- 'type' => 'string',
- 'example' => '20774ebd9abc71ef80486632b68f0102'."\n",
- ],
- 'VideoName' => [
- 'description' => '视频名字',
- 'type' => 'string',
- 'example' => '123.mp4',
- ],
- 'VideoId' => [
- 'description' => '视频Id',
- 'type' => 'string',
- 'example' => '20774ebd9abc71ef80486632b68f0102',
- ],
- 'In' => [
- 'description' => '片段开始时间(秒)已经废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Out' => [
- 'description' => '片段结束时间(秒)已经废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'ContentInner' => [
- 'description' => '口播分段内容',
- 'type' => 'string',
- 'example' => '口播分段内容',
- ],
- 'InEx' => [
- 'description' => '片段开始时间(毫秒)',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.33',
- ],
- 'OutEx' => [
- 'description' => '片段结束时间 (毫秒)',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '3.45',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'VoiceStyle' => [
- 'description' => '口播声音类型',
- 'type' => 'string',
- 'example' => '温柔女声',
- ],
- 'MusicStyle' => [
- 'description' => '推荐音乐类型',
- 'type' => 'string',
- 'example' => '国风',
- ],
- 'MusicUrl' => [
- 'description' => '背景音乐地址',
- 'type' => 'string',
- 'example' => 'http://music.mp4',
- ],
- 'MusicVolume' => [
- 'description' => '音乐音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'VoiceVolume' => [
- 'description' => '口播音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'SubtitleFontSize' => [
- 'description' => '字幕大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'OutputVideoUrl' => [
- 'description' => '成片地址',
- 'type' => 'string',
- 'example' => 'http://output.mp4',
- ],
- 'MediaCloudTimeline' => [
- 'description' => '视频云timeline',
- 'type' => 'string',
- 'example' => '视频云格式timeline',
- ],
- 'ColorWords' => [
- 'description' => '花字信息数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '花字信息元素',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '花字内容',
- 'type' => 'string',
- 'example' => '花字内容',
- ],
- 'TimelineIn' => [
- 'description' => '花字开始时间(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TimelineOut' => [
- 'description' => '花字结束时间(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'X' => [
- 'description' => '花字位置横坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.2',
- ],
- 'Y' => [
- 'description' => '花字位置纵坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.5',
- ],
- 'FontSize' => [
- 'description' => '花字大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'EffectColorStyle' => [
- 'description' => '花字效果',
- 'type' => 'string',
- 'example' => 'CS0002-000008',
- ],
- ],
- ],
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'CloseVoice' => [
- 'title' => '关闭口播',
- 'description' => '关闭口播',
- 'type' => 'boolean',
- ],
- 'CloseSubtitle' => [
- 'title' => '关闭字幕',
- 'description' => '关闭字幕',
- 'type' => 'boolean',
- ],
- 'CloseMusic' => [
- 'title' => '关闭音乐',
- 'description' => '关闭音乐',
- 'type' => 'boolean',
- ],
- 'CustomVoiceUrl' => [
- 'title' => '自定义声道文件地址',
- 'description' => '自定义声道文件地址',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.mp4',
- ],
- 'CustomVoiceVolume' => [
- 'title' => '自定义声道音量',
- 'description' => '自定义声道音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Stickers' => [
- 'title' => '贴纸数组',
- 'description' => '贴纸数组',
- 'type' => 'array',
- 'items' => [
- 'title' => '贴纸结构',
- 'description' => '贴纸结构',
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => '贴纸gif文件地址',
- 'description' => '贴纸gif文件地址',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.gif',
- ],
- 'TimelineIn' => [
- 'title' => '贴纸开始时间(秒)',
- 'description' => '贴纸开始时间(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Duration' => [
- 'title' => '贴纸出现时长',
- 'description' => '贴纸出现时长',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'X' => [
- 'title' => '贴纸出现位置横坐标',
- 'description' => '贴纸出现位置横坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'Y' => [
- 'title' => '贴纸出现位置纵坐标',
- 'description' => '贴纸出现位置纵坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '100',
- ],
- 'Width' => [
- 'title' => '贴纸宽度',
- 'description' => '贴纸宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Height' => [
- 'title' => '贴纸高度',
- 'description' => '贴纸高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'DyncFrames' => [
- 'title' => '贴纸高度',
- 'description' => '贴纸高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- ],
- ],
- ],
- 'CustomVoiceStyle' => [
- 'description' => 'cosyvoice的音色',
- 'type' => 'string',
- 'example' => 'longxian_normal',
- ],
- 'OutputVideoFileKey' => [
- 'description' => '输出结果fileKey',
- 'type' => 'string',
- 'example' => 'oss://xxx/xxx.mp4',
- ],
- 'OpeningCreditsUrl' => [
- 'description' => '片头视频地址',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.mp4',
- ],
- 'ClosingCreditsUrl' => [
- 'description' => '片尾视频地址',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.mp4',
- ],
- 'SourceVideos' => [
- 'description' => '剪辑素材结构列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '剪辑素材结构',
- 'type' => 'object',
- 'properties' => [
- 'VideoId' => [
- 'description' => '视频ID',
- 'type' => 'string',
- 'example' => 'fdaswe',
- ],
- 'VideoName' => [
- 'description' => '视频名称',
- 'type' => 'string',
- 'example' => 'video001.mp4',
- ],
- 'VideoUrl' => [
- 'description' => '视频地址。',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.mp4',
- ],
- ],
- ],
- ],
- 'ReferenceVideo' => [
- 'description' => '参考视频信息',
- 'type' => 'object',
- 'properties' => [
- 'VideoId' => [
- 'description' => '视频ID',
- 'type' => 'string',
- 'example' => '90ca686b11c371f08339752281ed0102',
- ],
- 'VideoName' => [
- 'description' => '视频名称',
- 'type' => 'string',
- 'example' => 'video001.mp4',
- ],
- 'VideoUrl' => [
- 'description' => '视频URL',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.mp4',
- ],
- ],
- ],
- 'AnalysisResults' => [
- 'description' => '视频理解结果列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '视频理解结果',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'description' => '视频Id',
- 'type' => 'string',
- 'example' => '975e1d91a8d057e132cc5d88e4d5b360',
- ],
- 'MediaName' => [
- 'description' => '视频名字',
- 'type' => 'string',
- 'example' => 'video001.mp4',
- ],
- 'MediaUrl' => [
- 'description' => '视频地址',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.mp4',
- ],
- 'LensInfos' => [
- 'description' => '镜头信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '镜头信息',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'description' => '开始时间',
- 'type' => 'object',
- 'properties' => [
- 'Hour' => [
- 'description' => '小时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Minute' => [
- 'description' => '分钟',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Second' => [
- 'description' => '秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'MillSecond' => [
- 'description' => '毫秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- 'EndTime' => [
- 'description' => '结束时间',
- 'type' => 'object',
- 'properties' => [
- 'Hour' => [
- 'description' => '时',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
- 'Minute' => [
- 'description' => '分',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Second' => [
- 'description' => '秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'MillSecond' => [
- 'description' => '毫秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- 'AnalysisContent' => [
- 'description' => '理解内容',
- 'type' => 'string',
- 'example' => '视频理解内容',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-12 21:46:24'],
+ 'UserId' => ['title' => '', 'description' => '有权限用户唯一标识', 'type' => 'string', 'example' => 'CustomSemanticSearch'],
+ 'Username' => ['title' => '', 'description' => '有权限用户名称', 'type' => 'string', 'example' => 'xxx'],
+ 'DataType' => ['title' => '', 'description' => '数据类型:'."\n"
+ .'- dataset:数据集', 'type' => 'string', 'example' => 'xxx'],
+ 'DataId' => ['description' => '数据权限数据唯一标识'."\n"
+ .'- dataset:SystemSearch.QuarkCommonNews', 'type' => 'string', 'example' => 'SystemSearch.QuarkCommonNews'."\n"],
+ 'Permission' => ['description' => '权限定义:默认只读 read', 'type' => 'string', 'example' => 'read'],
],
],
],
- 'HttpStatusCode' => [
- 'title' => '',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TotalCount' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '权限-列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDataPermissions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"e5a1a59c82d0454fad6454e8a04d0093\\",\\n \\"Step\\": \\"clips\\",\\n \\"Status\\": 0,\\n \\"Content\\": \\"口播内容\\",\\n \\"Timelines\\": [\\n {\\n \\"TimelineId\\": \\"20774ebd9abc71ef80486632b68f0102\\",\\n \\"Content\\": \\"口播内容\\",\\n \\"Clips\\": [\\n {\\n \\"ClipId\\": \\"20774ebd9abc71ef80486632b68f0102\\\\n\\",\\n \\"VideoName\\": \\"123.mp4\\",\\n \\"VideoId\\": \\"20774ebd9abc71ef80486632b68f0102\\",\\n \\"In\\": 0,\\n \\"Out\\": 5,\\n \\"ContentInner\\": \\"口播分段内容\\",\\n \\"InEx\\": 0.33,\\n \\"OutEx\\": 3.45\\n }\\n ]\\n }\\n ],\\n \\"VoiceStyle\\": \\"温柔女声\\",\\n \\"MusicStyle\\": \\"国风\\",\\n \\"MusicUrl\\": \\"http://music.mp4\\",\\n \\"MusicVolume\\": 5,\\n \\"VoiceVolume\\": 5,\\n \\"SubtitleFontSize\\": 5,\\n \\"OutputVideoUrl\\": \\"http://output.mp4\\",\\n \\"MediaCloudTimeline\\": \\"视频云格式timeline\\",\\n \\"ColorWords\\": [\\n {\\n \\"Content\\": \\"花字内容\\",\\n \\"TimelineIn\\": 0,\\n \\"TimelineOut\\": 5,\\n \\"X\\": 0.2,\\n \\"Y\\": 0.5,\\n \\"FontSize\\": 5,\\n \\"EffectColorStyle\\": \\"CS0002-000008\\"\\n }\\n ],\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"CloseVoice\\": true,\\n \\"CloseSubtitle\\": true,\\n \\"CloseMusic\\": true,\\n \\"CustomVoiceUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"CustomVoiceVolume\\": 0,\\n \\"Stickers\\": [\\n {\\n \\"Url\\": \\"http://xxx/xxx.gif\\",\\n \\"TimelineIn\\": 10,\\n \\"Duration\\": 10,\\n \\"X\\": 100,\\n \\"Y\\": 100,\\n \\"Width\\": 200,\\n \\"Height\\": 200,\\n \\"DyncFrames\\": 8\\n }\\n ],\\n \\"CustomVoiceStyle\\": \\"longxian_normal\\",\\n \\"OutputVideoFileKey\\": \\"oss://xxx/xxx.mp4\\",\\n \\"OpeningCreditsUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"ClosingCreditsUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"SourceVideos\\": [\\n {\\n \\"VideoId\\": \\"fdaswe\\",\\n \\"VideoName\\": \\"video001.mp4\\",\\n \\"VideoUrl\\": \\"http://xxx/xxx.mp4\\"\\n }\\n ],\\n \\"ReferenceVideo\\": {\\n \\"VideoId\\": \\"90ca686b11c371f08339752281ed0102\\",\\n \\"VideoName\\": \\"video001.mp4\\",\\n \\"VideoUrl\\": \\"http://xxx/xxx.mp4\\"\\n },\\n \\"AnalysisResults\\": [\\n {\\n \\"MediaId\\": \\"975e1d91a8d057e132cc5d88e4d5b360\\",\\n \\"MediaName\\": \\"video001.mp4\\",\\n \\"MediaUrl\\": \\"http://xxx/xxx.mp4\\",\\n \\"LensInfos\\": [\\n {\\n \\"StartTime\\": {\\n \\"Hour\\": 2,\\n \\"Minute\\": 1,\\n \\"Second\\": 30,\\n \\"MillSecond\\": 100\\n },\\n \\"EndTime\\": {\\n \\"Hour\\": 2,\\n \\"Minute\\": 1,\\n \\"Second\\": 30,\\n \\"MillSecond\\": 100\\n },\\n \\"AnalysisContent\\": \\"视频理解内容\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获得剪辑任务信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"Id\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"UserId\\": \\"CustomSemanticSearch\\",\\n \\"Username\\": \\"xxx\\",\\n \\"DataType\\": \\"xxx\\",\\n \\"DataId\\": \\"SystemSearch.QuarkCommonNews\\\\n\\",\\n \\"Permission\\": \\"read\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
],
- 'AsyncCreateClipsTask' => [
- 'summary' => '生成剪辑视频',
+ 'ListDatasetDocuments' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'TaskId',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '17a299a9-f223-4707-b0dd-4c22519bddf5',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'VoiceStyle',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'description' => '口播语音类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => '甜美女声'."\n"
- .'中国台湾话女声'."\n"
- .'舌尖男声'."\n"
- .'新闻男声'."\n"
- .'激昂解说'."\n"
- .'标准女声'."\n"
- .'悬疑解说'."\n"
- .'广告男声'."\n"
- .'温柔女声'."\n"
- .'资讯女声'."\n"
- .'新闻女声'."\n"
- .'萝莉女声'."\n"
- .'磁性男声',
- ],
+ 'schema' => ['title' => '搜索条件', 'description' => '搜索条件', 'type' => 'string', 'required' => false, 'example' => '搜索条件'],
],
[
- 'name' => 'MusicUrl',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'schema' => [
- 'description' => '背景音乐地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://music.mp4',
- ],
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识:DatasetName、DatasetId 二选一必填', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'ColorWords',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '花字数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '花字结构',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '花字内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '花字内容',
- ],
- 'TimelineIn' => [
- 'description' => '花字出现时间(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'TimelineOut' => [
- 'description' => '花字结束时间(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- 'X' => [
- 'description' => '花字位置横坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.2',
- ],
- 'Y' => [
- 'description' => '花字位置纵坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '0.5',
- ],
- 'FontSize' => [
- 'description' => '花字大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '默认120',
- ],
- 'EffectColorStyle' => [
- 'description' => '花字样式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CS0002-000007'."\n"
- .'参考:https://help.aliyun.com/zh/ims/developer-reference/flower-effect-example?spm=a2c4g.11186623.0.0.6ee43d29lo1EWu#88bc5f6046mg2',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => '数据集名称'],
],
[
- 'name' => 'WorkspaceId',
+ 'name' => 'Status',
'in' => 'formData',
- 'schema' => [
- 'description' => '[百炼业务空间Id](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-ipe7d81yq4sl5jmk',
- ],
+ 'schema' => ['title' => '文档索引构建状态', 'description' => '文档状态:'."\n"
+ .'- 1:创建完成'."\n"
+ .'- 2:文本索引构建完成'."\n"
+ .'- 3:多模态索引构建完成'."\n"
+ .'- 100:全量构建完成'."\n"
+ .'- 0:失败', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
],
[
- 'name' => 'VoiceVolume',
+ 'name' => 'DocType',
'in' => 'formData',
- 'schema' => [
- 'description' => '口播音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0-10,默认5',
- ],
+ 'schema' => ['title' => '文档类型', 'description' => '文档类型:'."\n"
+ .'- plainText:纯文本'."\n"
+ .'- richText:富文本'."\n"
+ .'- text:文本文件'."\n"
+ .'- pdf:'."\n"
+ .'- word:'."\n"
+ .'- image:图片'."\n"
+ .'- video:视频', 'type' => 'string', 'required' => false, 'example' => 'text'],
],
[
- 'name' => 'MusicVolume',
+ 'name' => 'DatasetDescription',
'in' => 'formData',
- 'schema' => [
- 'description' => '音乐音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0-10,默认5',
- ],
+ 'schema' => ['description' => '废弃', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'SubtitleFontSize',
+ 'name' => 'IncludeFields',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '字幕尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '包括字段',
+ 'description' => '包括字段',
+ 'type' => 'array',
+ 'items' => ['description' => '包括字段'."\n"
+ .'- content:正文'."\n"
+ .'- chunks:片段', 'type' => 'string', 'required' => false, 'example' => 'content'],
'required' => false,
- 'example' => '默认120',
],
],
[
- 'name' => 'Height',
+ 'name' => 'ExcludeFields',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '视频高度',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '排除字段',
+ 'description' => '排除字段:'."\n"
+ .'- content:正文',
+ 'type' => 'array',
+ 'items' => ['description' => '排除字段', 'type' => 'string', 'required' => false, 'example' => 'content'],
'required' => false,
- 'example' => '1920',
],
],
[
- 'name' => 'Width',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '视频宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1080',
- ],
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'],
],
[
- 'name' => 'CloseVoice',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '关闭口播',
- 'description' => '关闭口播',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '10'],
],
[
- 'name' => 'CloseMusic',
+ 'name' => 'CategoryUuids',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '关闭背景音乐',
- 'description' => '关闭背景音乐',
- 'type' => 'boolean',
+ 'description' => '类目唯一标识',
+ 'type' => 'array',
+ 'items' => ['description' => '类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
],
],
[
- 'name' => 'CloseSubtitle',
+ 'name' => 'Tags',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '关闭字幕',
- 'description' => '关闭字幕',
- 'type' => 'boolean',
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => ['description' => '标签', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
],
],
[
- 'name' => 'CustomVoiceUrl',
+ 'name' => 'Extend1',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义声道语音地址',
- 'description' => '自定义声道语音地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/xxx.mp4',
- ],
+ 'schema' => ['description' => '自定义扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'CustomVoiceVolume',
+ 'name' => 'Extend2',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义声道音量',
- 'description' => '自定义声道音量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['description' => '自定义扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'Stickers',
+ 'name' => 'Extend3',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '贴纸结构数组',
- 'description' => '贴纸结构数组',
- 'type' => 'array',
- 'items' => [
- 'title' => '贴纸数组元素',
- 'description' => '贴纸数组元素',
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => 'gif文件公网地址',
- 'description' => 'gif文件公网地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/xxx.gif',
- ],
- 'TimelineIn' => [
- 'title' => '贴纸开始时间(妙)',
- 'description' => '贴纸开始时间(妙)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
- 'Duration' => [
- 'title' => '贴纸显示时间(秒)',
- 'description' => '贴纸显示时间(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'X' => [
- 'title' => '贴纸位置x坐标',
- 'description' => '贴纸位置x坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '200',
- ],
- 'Y' => [
- 'title' => '贴纸位置y坐标',
- 'description' => '贴纸位置y坐标',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '200',
- ],
- 'Width' => [
- 'title' => '贴纸宽度',
- 'description' => '贴纸宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- 'Height' => [
- 'title' => '贴纸高度',
- 'description' => '贴纸高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- 'DyncFrames' => [
- 'title' => 'gif文件动态帧数',
- 'description' => 'gif文件动态帧数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '8',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '自定义扩展字段。', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'CustomVoiceStyle',
+ 'name' => 'CreateTimeStart',
'in' => 'formData',
- 'schema' => [
- 'description' => 'cosyvoice的音色',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'longxian_normal',
- ],
+ 'schema' => ['description' => '起始创建时间,时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
],
[
- 'name' => 'CosyVoiceAppKey',
+ 'name' => 'CreateTimeEnd',
'in' => 'formData',
- 'schema' => [
- 'description' => 'cosyvoice的appkey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ddgsase',
- ],
+ 'schema' => ['description' => '截止创建时间,时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
],
[
- 'name' => 'CosyVoiceToken',
+ 'name' => 'DocUuids',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => 'cosyvoice的token',
- 'type' => 'string',
+ 'description' => '文档唯一标识',
+ 'type' => 'array',
+ 'items' => ['description' => '文档唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'required' => false,
- 'example' => 'xxsfazs',
],
],
[
- 'name' => 'MusicStyle',
+ 'name' => 'DocIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '推荐音乐类型',
- 'type' => 'string',
+ 'description' => '文档ID数组',
+ 'type' => 'array',
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'required' => false,
- 'example' => '浪漫, 美食,国风,轻快,动感,舒缓,搞怪,时尚',
],
],
[
- 'name' => 'OpeningCreditsUrl',
+ 'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '片头视频地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/xxx.mp4',
- ],
+ 'schema' => ['description' => '开始时间;毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
],
[
- 'name' => 'ClosingCreditsUrl',
+ 'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '片尾视频地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/xxx.mp4',
- ],
+ 'schema' => ['description' => '结束时间:毫秒', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1111'],
],
[
- 'name' => 'HighDefSourceVideos',
+ 'name' => 'Title',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '高清视频结构列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '高清视频结构',
- 'type' => 'object',
- 'properties' => [
- 'VideoId' => [
- 'description' => '视频id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '00d59b6de13971f0bcd84531949c0102',
- ],
- 'VideoName' => [
- 'description' => '视频名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'video001.mp4',
- ],
- 'VideoUrl' => [
- 'description' => '视频URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://fotor-cn-cutout.oss-cn-shanghai.aliyuncs.com/cutout_tmp/01ba219486f043b4b339e7080e5cf11d.mp4',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '标题', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '下一页的唯一标识:查询第10000条以上数据时,必传', 'description' => '下一页的唯一标识:查询第10000条以上数据时,必传', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
],
'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' => 'successful',
- ],
'Data' => [
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocUuid' => ['title' => '内部文档唯一ID', 'description' => '内部文档唯一ID', 'type' => 'string', 'example' => '内部文档唯一ID'],
+ 'Url' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'https://xxx/xx'],
+ 'Content' => ['title' => '正文', 'description' => '正文', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => 'xx'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2022-01-01 00:00:00'],
+ 'SourceFrom' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '来源'],
+ 'DisableHandleMultimodalMedia' => ['title' => '当前记录是否落多模态索引库', 'description' => '当前记录是否落多模态索引库', 'type' => 'boolean', 'example' => 'false'],
+ 'MultimodalMedias' => [
+ 'description' => '多模态信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '多模态信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => '多模态数据唯一标识'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据类型', 'type' => 'string', 'example' => '多模态数据类型'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '图片或视频文件地址', 'type' => 'string', 'example' => '图片或视频文件地址'],
+ ],
+ ],
+ ],
+ 'DocId' => ['title' => '用户指定的文档唯一ID', 'description' => '用户指定的文档唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'DocType' => ['title' => '文档类型', 'description' => '文档类型', 'type' => 'string', 'example' => 'text'],
+ 'Status' => ['title' => '文档索引构建状态', 'description' => '文档索引构建状态', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'CategoryUuid' => ['title' => '类目唯一标识', 'description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['title' => '扩展字段1', 'description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['title' => '扩展字段2', 'description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['title' => '扩展字段3', 'description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-04-14 19:59:53'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2025-04-14 19:59:53'],
+ 'UpdateUser' => ['description' => '更新用户', 'type' => 'string', 'example' => '1'],
+ 'CreateUser' => ['description' => '创建者', 'type' => 'string', 'example' => '1'],
+ 'Tags' => [
+ 'description' => '标签。',
+ 'type' => 'array',
+ 'items' => ['description' => '标签。', 'type' => 'string', 'example' => 'xx'],
+ ],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页记录条数', 'description' => '每页记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '总记录条数', 'description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'NextToken' => ['title' => '下一页的唯一标识', 'description' => '下一页的唯一标识', 'type' => 'string', 'example' => 'xxx'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-文档列表',
+ 'summary' => '查询数据源文档列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-08T11:57:21.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDatasetDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '创建剪辑任务',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"DocUuid\\": \\"内部文档唯一ID\\",\\n \\"Url\\": \\"https://xxx/xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"PubTime\\": \\"2022-01-01 00:00:00\\",\\n \\"SourceFrom\\": \\"来源\\",\\n \\"DisableHandleMultimodalMedia\\": false,\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"DocType\\": \\"text\\",\\n \\"Status\\": 100,\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"CreateTime\\": \\"2025-04-14 19:59:53\\",\\n \\"UpdateTime\\": \\"2025-04-14 19:59:53\\",\\n \\"UpdateUser\\": \\"1\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"NextToken\\": \\"xxx\\"\\n}","type":"json"}]',
],
- 'ListAutoClipsTask' => [
- 'summary' => '列出智能混剪任务列表',
+ 'ListDatasets' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -19281,197 +13233,71 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '百炼业务空间',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'TaskName',
+ 'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'task001',
- ],
+ 'schema' => ['title' => '创建时间-开始', 'description' => '创建时间-开始', 'type' => 'string', 'required' => false, 'example' => '创建时间-开始'],
],
[
- 'name' => 'TaskType',
+ 'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'type001',
- ],
+ 'schema' => ['title' => '创建时间-结束', 'description' => '创建时间-结束', 'type' => 'string', 'required' => false, 'example' => '创建时间-结束'],
],
[
- 'name' => 'TaskStatus',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '数据集名称,全局唯一', 'description' => '数据集名称,全局唯一', 'type' => 'string', 'required' => false, 'example' => 'businessDataset'],
],
[
- 'name' => 'CreateTimeStart',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务开始时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-02-19 07:28:11',
- ],
+ 'schema' => ['title' => '数据集id', 'description' => '数据集id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'CreateTimeEnd',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务结束时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-18 02:00:00',
- ],
+ 'schema' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'string', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'Current',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '当前页:默认1', 'description' => '当前页:默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
],
[
- 'name' => 'Size',
+ 'name' => 'DatasetType',
'in' => 'formData',
- 'schema' => [
- 'description' => '每页条数:默认 10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '数据集类型', 'description' => '数据集类型', 'type' => 'string', 'required' => false, 'example' => 'CustomSemanticSearch'],
],
[
- 'name' => 'Skip',
+ 'name' => 'SearchDatasetEnable',
'in' => 'formData',
- 'schema' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'IncludeConfig',
'in' => 'formData',
- 'schema' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '是否返回配置和用量信息,默认不返回', 'description' => '是否返回配置和用量信息,默认不返回', 'type' => 'boolean', 'required' => false, 'default' => 'true'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'DatasetDescription',
'in' => 'formData',
- 'schema' => [
- 'description' => '废弃',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '数据集描述', 'description' => '数据集描述', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
],
'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' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MaxResults' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'null',
- ],
- 'NextToken' => [
- 'description' => '废弃',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'TotalCount' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'null',
- ],
- 'Current' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
'Data' => [
'description' => '业务数据',
'type' => 'array',
@@ -19479,380 +13305,214 @@
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '任务名称',
- ],
- 'TaskType' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'example' => 'type001',
- ],
- 'TaskStatus' => [
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'TaskStep' => [
- 'description' => 'upload',
- 'type' => 'string',
- 'example' => 'upload'."\n"
- .'clips'."\n"
- .'generate',
- ],
- 'CreateTimeStart' => [
- 'description' => '起始创建时间。',
- 'type' => 'string',
- 'example' => '2023-03-18 02:00:00'."\n",
+ 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-12 21:46:24'],
+ 'DatasetType' => ['title' => '数据集类型', 'description' => '数据集类型', 'type' => 'string', 'example' => 'CustomSemanticSearch'],
+ 'DatasetName' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'example' => 'xxx'],
+ 'DatasetDescription' => ['title' => '数据集显示名称', 'description' => '数据集显示名称', 'type' => 'string', 'example' => 'xxx'],
+ 'SearchDatasetEnable' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DocUsedQuota' => ['title' => '当前数据集已上传文档总数', 'description' => '当前数据集已上传文档总数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'AccessLevel' => ['title' => '开放级别', 'description' => '开放级别', 'type' => 'string', 'example' => 'private'],
+ 'Administrators' => [
+ 'title' => '管理员',
+ 'description' => '管理员',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '管理员',
+ 'description' => '管理员',
+ 'type' => 'object',
+ 'properties' => [
+ 'Username' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'example' => 'xx'],
+ 'UserId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => 'xx'],
+ ],
+ ],
],
],
],
],
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TotalCount' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'CustomSemanticSearchConfig' => [
+ 'title' => '"上传文件用作数据源"场景索引配置和用量信息',
+ 'description' => '"上传文件用作数据源"场景索引配置和用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocQuota' => ['title' => '总文档配额', 'description' => '总文档配额', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'DocUsedQuota' => ['title' => '总文档已使用配额', 'description' => '总文档已使用配额', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'DatasetQuota' => ['title' => '数据集数量配额', 'description' => '数据集数量配额', 'type' => 'integer', 'format' => 'int32', 'example' => '3'],
+ 'DatasetUsedQuota' => ['title' => '数据集数量已使用配额', 'description' => '数据集数量已使用配额', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ 'ThirdSearchConfig' => [
+ 'title' => '"通过API引入数据源"场景配置和用量信息',
+ 'description' => '"通过API引入数据源"场景配置和用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'DatasetQuota' => ['title' => '数据集数量配额', 'description' => '数据集数量配额', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'DatasetUsedQuota' => ['title' => '数据集数量已使用配额', 'description' => '数据集数量已使用配额', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-列表',
+ 'summary' => '数据源管理-查询。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-08T11:59:06.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDatasets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"null\\",\\n \\"TotalCount\\": 0,\\n \\"Current\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 20,\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"TaskType\\": \\"type001\\",\\n \\"TaskStatus\\": 0,\\n \\"TaskStep\\": \\"upload\\\\nclips\\\\ngenerate\\",\\n \\"CreateTimeStart\\": \\"2023-03-18 02:00:00\\\\n\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '智能混剪任务列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1,\\n \\"DocUsedQuota\\": 1,\\n \\"AccessLevel\\": \\"private\\",\\n \\"Administrators\\": [\\n {\\n \\"Username\\": \\"xx\\",\\n \\"UserId\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"CustomSemanticSearchConfig\\": {\\n \\"DocQuota\\": 1000,\\n \\"DocUsedQuota\\": 1,\\n \\"DatasetQuota\\": 3,\\n \\"DatasetUsedQuota\\": 1\\n },\\n \\"ThirdSearchConfig\\": {\\n \\"DatasetQuota\\": 2,\\n \\"DatasetUsedQuota\\": 1\\n }\\n}","type":"json"}]',
],
- 'SubmitCustomSourceTopicAnalysis' => [
- 'summary' => '从自定义数据源提交选题热点分析',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListDialogues' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'FileUrl',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文件URL(FileUrl与News二选一)',
- 'description' => '文件URL(FileUrl与News二选一)(文件的结构请参考 News字段)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxx.json',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'FileType',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件类型',
- 'description' => '文件类型(json: json数组格式,jsonLine:json行格式)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'json',
- ],
+ 'schema' => ['title' => '任务唯一标识', 'description' => '任务唯一标识'."\n"
+ ."\n"
+ .'> '."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'maxLength' => 64, 'minLength' => 6],
],
[
- 'name' => 'MaxTopicSize',
+ 'name' => 'StartTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大分析的话题数量',
- 'description' => '最大分析的话题数量(默认情况下 会按照聚类后的新闻数量倒排,取TOP50 进行话题分析,最大200条 )',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '50',
- ],
+ 'schema' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-04 11:46:07'],
],
[
- 'name' => 'News',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '新闻列表(FileUrl与News二选一)',
- 'description' => '新闻列表(FileUrl与News二选一)',
- 'type' => 'array',
- 'items' => [
- 'title' => '新闻对象',
- 'description' => '新闻对象',
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'title' => '新闻标题 ',
- 'description' => '新闻标题 ',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新闻标题',
- ],
- 'Content' => [
- 'title' => '新闻正文',
- 'description' => '新闻正文',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新闻正文'."\n"
- ."\n",
- ],
- 'Url' => [
- 'title' => '新闻URL',
- 'description' => '新闻URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxx.html'."\n",
- ],
- 'Comments' => [
- 'title' => '评论列表',
- 'description' => '评论列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '评论对象',
- 'description' => '评论对象',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '评论内容',
- 'description' => '评论内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '评论内容'."\n"
- ."\n",
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'PubTime' => [
- 'title' => '发布时间(格式为: YYYY-MM-dd HH:mm:ss)',
- 'description' => '发布时间(格式为: YYYY-MM-dd HH:mm:ss)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-22 10:29:00',
- ],
- 'Source' => [
- 'title' => '新闻来源',
- 'description' => '新闻来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '百度',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'WorkspaceId',
+ 'name' => 'EndTime',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间ID',
- 'description' => '[百炼业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-04 11:46:07'],
],
[
- 'name' => 'AnalysisTypes',
+ 'name' => 'DialogueType',
'in' => 'formData',
- 'style' => 'json',
'schema' => [
- 'title' => '选题热点要分析的类型(多选,不传默认分析全部。 传空数组,默认不做选题热点分析,仅聚类。)'."\n"
- .'HotViewPoints: 热门选题视角分析'."\n"
- .'WebReviewPoints: 网友选题视角分析(需要有评论)'."\n"
- .'TimedViewPoints:时效性选题视角分析'."\n"
- .'FreshViewPoints:新颖视角分析'."\n"
- .'TopicSummary:新闻摘要分析'."\n",
- 'description' => '选题热点要分析的类型(多选,不传默认分析全部。 传空数组,默认不做选题热点分析,仅聚类。)'."\n"
- .'HotViewPoints: 热门选题视角分析'."\n"
- .'WebReviewPoints: 网友选题视角分析(需要有评论)'."\n"
- .'TimedViewPoints:时效性选题视角分析'."\n"
- .'FreshViewPoints:新颖视角分析'."\n"
- .'TopicSummary:新闻摘要分析'."\n",
- 'type' => 'array',
- 'items' => [
- 'description' => '选题热点要分析的类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TimedViewPoints',
- ],
+ 'title' => '生成类型:1:创作;2:智搜(默认)',
+ 'description' => '生成类型:1:创作;2:智搜(默认)',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
+ 'example' => '2',
+ 'default' => '2',
+ 'enum' => ['1', '2'],
],
],
[
- 'name' => 'Topics',
+ 'name' => 'Current',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '话题列表',
- 'description' => '话题列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '话题对象',
- 'description' => '话题对象',
- 'type' => 'object',
- 'properties' => [
- 'Topic' => [
- 'title' => '话题名称',
- 'description' => '话题名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '话题名称',
- ],
- 'News' => [
- 'title' => '新闻列表',
- 'description' => '新闻列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '新闻对象',
- 'description' => '新闻对象',
- 'required' => false,
- '$ref' => '#/components/schemas/HottopicNews',
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'TopicsFileUrl',
+ 'name' => 'Size',
'in' => 'formData',
- 'schema' => [
- 'title' => '话题列表URL(使用 json line 格式,每行是一个json)',
- 'description' => '话题列表URL(使用 json line 格式,每行是一个json)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://www.example.com/xxx.jsonline',
- ],
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '任务名称',
+ 'description' => '生成历史列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '生成历史',
+ 'type' => 'object',
+ 'properties' => [
+ 'Bot' => ['title' => '模型生成', 'description' => '模型生成', 'type' => 'string', 'example' => 'xx'],
+ 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2024-01-04 11:46:07'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => 'xx'],
+ 'DialogueType' => ['title' => '生成类型:1:创作;2:智搜(默认)', 'description' => '生成类型:1:创作;2:智搜(默认)', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xx'],
+ 'User' => ['title' => '用户输入', 'description' => '用户输入', 'type' => 'string', 'example' => 'x'],
],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Size' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成历史列表',
+ 'summary' => '在线推理场景的历史记录。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDialogues'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDialogues',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交自定义源话题选题分析任务',
- 'requestParamsDescription' => '支持两种分析模式'."\n"
- .'1. 传 一批文章,进行 新闻聚类 -> 然后进行 选题策划分析'."\n"
- .' 1. 待分析的内容为 新闻列表 对象 具体结构 请参考:News字段。'."\n"
- .' 2. News字段与fileUrl字段二选一'."\n"
- .' 3. 支持分析的新闻数最大支持 1w条新闻。 '."\n"
- .' 4. 支持最大 产出的聚合话题 200个。由参数:MaxTopicSize控制。'."\n"
- ."\n"
- .'2. 从聚类好的新闻 直接进行选题策划分析'."\n"
- .' 1. 待分析的内容为 话题列表 对象 具体结构 请参考:Topics字段'."\n"
- .' 2. Topics字段与TopicsFileUrl字段二选一'."\n"
- ."\n"
- .'3. 支持将分析结果导出为 json 或者 excel。参考[导出接口](~~2929476~~)的ExportType字段'."\n"
- ."\n"
- .'4. 最佳实践请参考:[妙策自定义数据源最佳实践](https://help.aliyun.com/zh/model-studio/best-practices-for-miaoce-api?spm=a2c4g.11186623.help-menu-2400256.d_1_12_6_2_1_1.6acd4b9e5922F7&scm=20140722.H_2848246._.OR_help-T_cn~zh-V_1#42209ec83blza)',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Bot\\": \\"xx\\",\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"CreateUser\\": \\"xx\\",\\n \\"DialogueType\\": 2,\\n \\"TaskId\\": \\"xx\\",\\n \\"User\\": \\"x\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
],
- 'GetCustomSourceTopicAnalysisTask' => [
- 'summary' => '获取自定义数据源-选题视角分析任务结果',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListDocs' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -19860,485 +13520,126 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'DocName',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'ParsedNewsSize' => [
- 'title' => '解析后的新闻数量',
- 'description' => '解析文件后的新闻数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'ClusterCount' => [
- 'title' => '聚类后的文档数量',
- 'description' => '聚类后的文档数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'MaxClusteredTopicNewsSize' => [
- 'description' => '聚合后的最大新闻数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'ClusterResults' => [
- 'title' => '新闻聚合结果列表',
- 'description' => '新闻聚合结果列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '聚合结果对象',
- 'description' => '聚合结果对象',
- 'type' => 'object',
- 'properties' => [
- 'ClusterNews' => [
- 'title' => '聚合新闻列表(不包含正文)',
- 'description' => '聚合新闻列表(不包含正文)',
- 'type' => 'array',
- 'items' => [
- 'title' => '新闻对象',
- 'description' => '新闻对象',
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'title' => '新闻标题',
- 'description' => '新闻标题',
- 'type' => 'string',
- 'example' => '新闻标题'."\n"
- ."\n",
- ],
- 'Url' => [
- 'title' => '新闻Url',
- 'description' => '新闻Url',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.html',
- ],
- ],
- ],
- ],
- 'Topic' => [
- 'title' => '聚合话题名称',
- 'description' => '聚合话题名称',
- 'type' => 'string',
- 'example' => '话题名称',
- ],
- ],
- ],
- ],
- 'usages' => [
- 'title' => 'token使用情况。可能使用到的付费项为:'."\n"
- .'quanmiaoMax、quanmiaoPlus',
- 'description' => 'token使用情况。可能使用到的付费项为:'."\n"
- .'quanmiaoMax、quanmiaoPlus',
- 'type' => 'object',
- 'additionalProperties' => [
- 'title' => 'token使用数量',
- 'description' => 'token使用数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- 'rt' => [
- 'title' => '总运行时长,单位毫秒',
- 'description' => '总运行时长,单位毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- ],
- ],
- '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',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
+ 'schema' => ['description' => '文档名称', 'type' => 'string', 'required' => false, 'example' => '企业2022年報'],
],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ [
+ 'name' => 'DocType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档类型', 'type' => 'string', 'required' => false, 'example' => 'pdf'],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ParsedNewsSize\\": 10,\\n \\"ClusterCount\\": 5,\\n \\"MaxClusteredTopicNewsSize\\": 8,\\n \\"ClusterResults\\": [\\n {\\n \\"ClusterNews\\": [\\n {\\n \\"Title\\": \\"新闻标题\\\\n\\\\n\\",\\n \\"Url\\": \\"http://www.example.com/xxx.html\\"\\n }\\n ],\\n \\"Topic\\": \\"话题名称\\"\\n }\\n ],\\n \\"usages\\": {\\n \\"key\\": 200\\n },\\n \\"rt\\": 1000\\n },\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '获取自定义源话题分析任务结果',
- ],
- 'ExportCustomSourceAnalysisTask' => [
- 'summary' => '导出-自定义数据源-选题视角分析任务结果',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'Skip',
+ 'in' => 'formData',
+ 'schema' => ['description' => '跳过n条记录,用于分页', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:AgentKey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['description' => '返回的最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2',
- ],
+ 'schema' => ['description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '52a33dc83779f63641e16f5146cd7125'],
],
[
- 'name' => 'ExportType',
+ 'name' => 'Statuses',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '导出格式类型,默认 jsonLine'."\n"
- .'jsonline: 导出为jsonLine格式'."\n"
- .'excel:导出为excel格式',
- 'description' => '导出格式类型,默认 jsonLine'."\n"
- .'jsonline: 导出为jsonLine格式'."\n"
- .'excel:导出为excel格式',
- 'type' => 'string',
+ 'description' => '文档状态列表',
+ 'type' => 'array',
+ 'items' => ['description' => '状态值', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
'required' => false,
- 'example' => 'jsonLine',
],
],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档所在目录', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['description' => '返回结果编码。', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '可公网访问的URL',
- 'description' => '可公网访问的URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.jsonLine'."\n",
- ],
- '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',
+ 'description' => '返回数据结果列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '分页数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => ['description' => '创建时间', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-01-04 11:46:07'],
+ 'DocId' => ['description' => '文档ID', 'type' => 'string', 'example' => '12345'],
+ 'DocName' => ['description' => '文档名称', 'type' => 'string', 'example' => '标题093'],
+ 'DocType' => ['description' => '文档类型', 'type' => 'string', 'example' => 'pdf'],
+ 'Status' => ['description' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'StatusMessage' => ['description' => '状态消息', 'type' => 'string', 'example' => '导入完成'],
+ 'CategoryId' => ['description' => '文档所在目录', 'type' => 'string', 'example' => 'default'],
+ ],
+ ],
],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Message' => ['description' => '返回消息。', 'type' => 'string', 'example' => 'successful'],
+ 'NextToken' => ['description' => '下一页Token', 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4mYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc='],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"http://www.example.com/xxx.jsonLine\\\\n\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '导出自定义源-话题分析任务结果',
- 'responseParamsDescription' => '文件返回格式为 jsonLine,每行为一个json对象。json对象格式如下:'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| topic | string | 话题名称 |'."\n"
- .'| topicSummaryResult | array\\<TopicSummaryResult> | 话题摘要列表'."\n"
- .'| hotViewPointsResult | HotViewPointsResult | 热门视角分析结果'."\n"
- .'| timedViewPointsResult | TimedViewPointsResult | 时效性视角分析结果'."\n"
- .'| webReviewPointsResult | WebReviewPointsResult | 网友视角分析结果'."\n"
- .'| freshViewPointsResult | FreshViewPointsResult | 新颖视角分析结果'."\n"
- ."\n"
- .'## TopicSummaryResult(话题摘要)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| summaries | array\\<SummaryItem> | 话题摘要列表|'."\n"
- ."\n"
- .'### SummaryItem(话题摘要)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| title | string | 话题摘要标题 |'."\n"
- .'| summary | string | 话题摘要内容 |'."\n"
- .'| docList | array\\<DocItem> | 摘要引用的文档列表 |'."\n"
- ."\n"
- .'### DocItem(引用的文档)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| title | string | 文档标题 |'."\n"
- .'| url | string | 文档链接 |'."\n"
- .'| source | string | 文档来源 |'."\n"
- ."\n\n"
- .'## HotViewPointsResult(热门视角分析结果)'."\n"
- ."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| attitudes | array\\<HotAttitudeItem> | 热门视角列表|'."\n"
- ."\n"
- .'### HotAttitudeItem(热门视角)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| attitude | string | 热门视角 |'."\n"
- .'| attitudeType | string | 热门视角类型 |'."\n"
- .'| news | array\\<HotNewsItem> | 热门视角引用的文章列表|'."\n"
- .'| ratio | string | 该热门视角在整个话题中的占比 |'."\n"
- .'| viewPoints | array\\<HotViewPointItem> | 热门视角的策划提案列表 |'."\n"
- ."\n\n"
- .'### HotNewsItem(热门视角引用的文章)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| title | string | 文章标题 |'."\n"
- .'| url | string | 文章链接 |'."\n"
- .'| source | string | 文章来源 |'."\n"
- ."\n"
- .'### HotViewPointItem(热门视角选题)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| point | string | 选题策划方向 | '."\n"
- .'| summary | string | 选题策划方向的概要 |'."\n"
- .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
- ."\n"
- .'### OutlineItem'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| outline | string | 提纲标题 |'."\n"
- .'| summary | string | 提纲概要 |'."\n"
- ."\n\n"
- ."\n\n"
- ."\n\n"
- .'## TimedViewPointsResult(时效性视角分析结果)'."\n"
- ."\n\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| attitudes | array\\<TimedAttitudeItem> | 时效性视角列表|'."\n"
- ."\n"
- .'### TimedAttitudeItem(时效性视角)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| docUuid | string | 新闻唯一标识 |'."\n"
- .'| title | string | 新闻标题 |'."\n"
- .'| url | string | 新闻链接 |'."\n"
- .'| source | string | 新闻来源 |'."\n"
- .'| pubTime | string | 新闻发布时间 |'."\n"
- .'| viewPoints | array\\<TimedViewPointItem> | 时效性视角的策划提案列表 |'."\n"
- ."\n"
- .'### TimedViewPointItem(时效性视角选题)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| point | string | 选题策划方向 |'."\n"
- .'| summary | string | 选题策划方向的概要 |'."\n"
- .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
- ."\n"
- .'### OutlineItem'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| outline | string | 提纲标题 |'."\n"
- .'| summary | string | 提纲概要 |'."\n"
- ."\n\n"
- .'## WebReviewPointsResult(网友视角分析结果)'."\n"
- ."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| attitudes | array\\<WebReviewAttitudeItem> | 网友视角列表|'."\n"
- ."\n"
- .'### WebReviewAttitudeItem(网友视角)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| attitude | string | 网友视角 |'."\n"
- .'| attitudeType | string | 网友视角类型 |'."\n"
- .'| ratio | string | 该网友视角在整个话题中的占比 |'."\n"
- .'| comments | array\\<WebReviewCommentItem> | 网友评论列表|'."\n"
- .'| viewPoints | array\\<WebReviewViewPointItem> | 网友视角的策划提案列表 |'."\n"
- ."\n\n"
- ."\n"
- .'### WebReviewCommentItem(网友评论)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| text | string | 网友评论 |'."\n"
- .'| source | string | 网友评论来源 |'."\n"
- .'| url | string | 网友评论来源新闻链接 |'."\n"
- .'| title | string | 网友评论来源新闻标题 |'."\n"
- ."\n"
- .'### WebReviewViewPointItem(网友视角选题)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| point | string | 选题策划方向 |'."\n"
- .'| summary | string | 选题策划方向的概要 |'."\n"
- .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
- ."\n"
- .'### OutlineItem'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| outline | string | 提纲标题 |'."\n"
- .'| summary | string | 提纲概要 |'."\n"
- ."\n\n"
- .'## FreshViewPointsResult()'."\n"
- ."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| attitudes | array\\<FreshAttitudeItem> | 新颖视角列表|'."\n"
- ."\n"
- .'### FreshAttitudeItem(新颖视角)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| viewPoints | array\\<FreshViewPointItem> | 新颖视角的策划提案列表 |'."\n"
- ."\n"
- .'### FreshViewPointItem(新颖视角选题)'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| point | string | 选题策划方向 |'."\n"
- .'| summary | string | 选题策划方向的概要 |'."\n"
- .'| outlines | array\\<OutlineItem> | 选题策划方向的提纲 |'."\n"
- ."\n"
- .'### OutlineItem'."\n"
- .'| 字段名称 | 字段类型 | 字段描述 |'."\n"
- .'| ------------ | ------------ | ------------ |'."\n"
- .'| outline | string | 提纲标题 |'."\n"
- .'| summary | string | 提纲概要 |',
+ 'title' => '获取文档列表',
+ 'summary' => '妙读获取文档列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDocs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DocId\\": \\"12345\\",\\n \\"DocName\\": \\"标题093\\",\\n \\"DocType\\": \\"pdf\\",\\n \\"Status\\": 0,\\n \\"StatusMessage\\": \\"导入完成\\",\\n \\"CategoryId\\": \\"default\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 10,\\n \\"Message\\": \\"successful\\",\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4mYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 70\\n}","type":"json"}]',
],
'ListDocumentRetrieve' => [
'summary' => '根据复杂条件进行政务公文库的检索。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -20346,263 +13647,172 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '94',
- ],
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '94'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cEoBWREAXdxaOyjq/cqAbg==',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='],
],
[
'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'title' => '搜索条件',
- 'description' => '搜索条件',
- 'type' => 'string',
- 'required' => false,
- 'example' => '检索Query',
- ],
+ 'schema' => ['title' => '搜索条件', 'description' => '搜索条件', 'type' => 'string', 'required' => false, 'example' => '检索Query'],
],
[
'name' => 'ContentType',
'in' => 'formData',
- 'schema' => [
- 'title' => '文章体裁,0(null):全部(默认值), 1:公文,2:重要文章 5:政策解读 6:法律条文 7:规章法规 8:总书记',
- 'description' => '文章体裁,0(null):全部(默认值), 1:公文,2:重要文章 5:政策解读 6:法律条文 7:规章法规 8:总书记',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '文章体裁,0(null):全部(默认值), 1:公文,2:重要文章 5:政策解读 6:法律条文 7:规章法规 8:总书记', 'description' => '文章体裁,0(null):全部(默认值), 1:公文,2:重要文章 5:政策解读 6:法律条文 7:规章法规 8:总书记', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'SubContentType',
'in' => 'formData',
- 'schema' => [
- 'title' => ' * 文章体裁二级分类,文章体裁为总书记时:1:动态 2:讲话 3:思想 4:理论'."\n"
- .' * 文章体裁为公文时:-1: 其他 0:决议 1:决定 2:令 3:公报 4:公告 5:通告 6:意见 7:通知 8:通报 9:报告 10:请示 11:批复 12: 议案 13:函'."\n"
- .' * 14: 纪要'."\n"
- .' * 文章体裁为重要文章时:1:重要评论 2:重要理论 3:其他文章'."\n"
- .' * 文章体裁为规章法规时:3:行政法规 4:监察法规 5:地方性法规 7:部门规章 8:其他 9:党章党规'."\n"
- .' * 文章体裁为法律条文时:1:宪法 2:法律 6:司法解释',
- 'description' => ' * 文章体裁二级分类,文章体裁为总书记时:1:动态 2:讲话 3:思想 4:理论'."\n"
- .' * 文章体裁为公文时:-1: 其他 0:决议 1:决定 2:令 3:公报 4:公告 5:通告 6:意见 7:通知 8:通报 9:报告 10:请示 11:批复 12: 议案 13:函'."\n"
- .' * 14: 纪要'."\n"
- .' * 文章体裁为重要文章时:1:重要评论 2:重要理论 3:其他文章'."\n"
- .' * 文章体裁为规章法规时:3:行政法规 4:监察法规 5:地方性法规 7:部门规章 8:其他 9:党章党规'."\n"
- .' * 文章体裁为法律条文时:1:宪法 2:法律 6:司法解释',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => ' * 文章体裁二级分类,文章体裁为总书记时:1:动态 2:讲话 3:思想 4:理论'."\n"
+ .' * 文章体裁为公文时:-1: 其他 0:决议 1:决定 2:令 3:公报 4:公告 5:通告 6:意见 7:通知 8:通报 9:报告 10:请示 11:批复 12: 议案 13:函'."\n"
+ .' * 14: 纪要'."\n"
+ .' * 文章体裁为重要文章时:1:重要评论 2:重要理论 3:其他文章'."\n"
+ .' * 文章体裁为规章法规时:3:行政法规 4:监察法规 5:地方性法规 7:部门规章 8:其他 9:党章党规'."\n"
+ .' * 文章体裁为法律条文时:1:宪法 2:法律 6:司法解释', 'description' => ' * 文章体裁二级分类,文章体裁为总书记时:1:动态 2:讲话 3:思想 4:理论'."\n"
+ .' * 文章体裁为公文时:-1: 其他 0:决议 1:决定 2:令 3:公报 4:公告 5:通告 6:意见 7:通知 8:通报 9:报告 10:请示 11:批复 12: 议案 13:函'."\n"
+ .' * 14: 纪要'."\n"
+ .' * 文章体裁为重要文章时:1:重要评论 2:重要理论 3:其他文章'."\n"
+ .' * 文章体裁为规章法规时:3:行政法规 4:监察法规 5:地方性法规 7:部门规章 8:其他 9:党章党规'."\n"
+ .' * 文章体裁为法律条文时:1:宪法 2:法律 6:司法解释', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'Region',
'in' => 'formData',
- 'schema' => [
- 'title' => '区域 可直接输入 省 或者市 如吉林省 或者北京市',
- 'description' => '区域 可直接输入 省 或者市 如吉林省 或者北京市',
- 'type' => 'string',
- 'required' => false,
- 'example' => '北京市',
- ],
+ 'schema' => ['title' => '区域 可直接输入 省 或者市 如吉林省 或者北京市', 'description' => '区域 可直接输入 省 或者市 如吉林省 或者北京市', 'type' => 'string', 'required' => false, 'example' => '北京市'],
],
[
'name' => 'Source',
'in' => 'formData',
- 'schema' => [
- 'title' => '来源,0:内部(本单位) 1:外部(外单位)',
- 'description' => '来源,0:内部(本单位) 1:外部(外单位)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '来源,0:内部(本单位) 1:外部(外单位)', 'description' => '来源,0:内部(本单位) 1:外部(外单位)', 'type' => 'string', 'required' => false, 'example' => '1'],
],
[
'name' => 'StartDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '发文起始时间,yyyy-MM-dd',
- 'description' => '发文起始时间,yyyy-MM-dd',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-10-10',
- ],
+ 'schema' => ['title' => '发文起始时间,yyyy-MM-dd', 'description' => '发文起始时间,yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-10-10'],
],
[
'name' => 'EndDate',
'in' => 'formData',
- 'schema' => [
- 'title' => '发文结束时间,yyyy-MM-dd',
- 'description' => '发文结束时间,yyyy-MM-dd',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2025-07-03',
- ],
+ 'schema' => ['title' => '发文结束时间,yyyy-MM-dd', 'description' => '发文结束时间,yyyy-MM-dd', 'type' => 'string', 'required' => false, 'example' => '2025-07-03'],
],
[
'name' => 'Office',
'in' => 'formData',
- 'schema' => [
- 'title' => '发文单位',
- 'description' => '发文单位',
- 'type' => 'string',
- 'required' => false,
- 'example' => '国务院办公室',
- ],
+ 'schema' => ['title' => '发文单位', 'description' => '发文单位', 'type' => 'string', 'required' => false, 'example' => '国务院办公室'],
],
[
'name' => 'WordSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '发文字号',
- 'description' => '发文字号',
- 'type' => 'string',
- 'required' => false,
- 'example' => '宁民规〔2020〕5号',
- ],
+ 'schema' => ['title' => '发文字号', 'description' => '发文字号', 'type' => 'string', 'required' => false, 'example' => '宁民规〔2020〕5号'],
],
[
'name' => 'ElementScope',
'in' => 'formData',
- 'schema' => [
- 'title' => '检索要素范围,1:标题 0:全文(标题和内容),默认',
- 'description' => '检索要素范围,1:标题 0:全文(标题和内容),默认',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '检索要素范围,1:标题 0:全文(标题和内容),默认', 'description' => '检索要素范围,1:标题 0:全文(标题和内容),默认', 'type' => 'string', 'required' => false, 'example' => '0'],
],
[
'name' => 'SubjectClassify',
'in' => 'formData',
- 'schema' => [
- 'title' => '支持如下分类'."\n"
- ."\n"
- .'一级分类 二级分类'."\n"
- .'国防和交流合作事务 国防'."\n"
- .'国防和交流合作事务 对外事务'."\n"
- .'国防和交流合作事务 军事工作'."\n"
- .'国防和交流合作事务 港澳台侨工作'."\n"
- .'综合政务 二十大'."\n"
- .'综合政务 政务公开与督查'."\n"
- .'综合政务 联合政务'."\n"
- .'综合政务 党建工作'."\n"
- .'综合政务 会议及提案'."\n"
- .'综合政务 政务文件管理'."\n"
- .'综合政务 其他政务'."\n"
- .'国务院组织机构 国务院'."\n"
- .'国务院组织机构 国务院办公厅'."\n"
- .'国务院组织机构 国务院机构'."\n"
- .'行政监管与市场监管 行政监管'."\n"
- .'行政监管与市场监管 信用监管'."\n"
- .'行政监管与市场监管 产品质量监督'."\n"
- .'行政监管与市场监管 安全生产监管'."\n"
- .'行政监管与市场监管 市场监管'."\n"
- .'经济管理 国民经济'."\n"
- .'经济管理 市场经济'."\n"
- .'经济管理 经济体制改革'."\n"
- .'经济管理 国有资产监管'."\n"
- .'财政金融商贸 财政'."\n"
- .'财政金融商贸 金融'."\n"
- .'财政金融商贸 审计'."\n"
- .'财政金融商贸 商贸'."\n"
- .'财政金融商贸 海关'."\n"
- .'人事工作与社会保障 人事工作'."\n"
- .'人事工作与社会保障 人口与计划生育'."\n"
- .'人事工作与社会保障 妇女儿童工作'."\n"
- .'人事工作与社会保障 扶贫'."\n"
- .'人事工作与社会保障 减灾救灾'."\n"
- .'人事工作与社会保障 公共服务'."\n"
- .'人事工作与社会保障 社会福利与救助'."\n"
- .'人事工作与社会保障 优抚安置'."\n"
- .'人事工作与社会保障 社会保障'."\n"
- .'公共安全与社会管理 公安'."\n"
- .'公共安全与社会管理 安全'."\n"
- .'公共安全与社会管理 司法'."\n"
- .'公共安全与社会管理 消防'."\n"
- .'公共安全与社会管理 民族'."\n"
- .'公共安全与社会管理 宗教'."\n"
- .'科教文体 文化'."\n"
- .'科教文体 科技创新'."\n"
- .'科教文体 教育'."\n"
- .'科教文体 知识产权'."\n"
- .'科教文体 新闻出版'."\n"
- .'科教文体 广电与互联网'."\n"
- .'科教文体 体育'."\n"
- .'科教文体 旅游'."\n"
- .'医疗卫生 卫生'."\n"
- .'医疗卫生 医疗'."\n"
- .'医疗卫生 动物医学'."\n"
- .'城乡建设与工业发展 城乡建设'."\n"
- .'城乡建设与工业发展 工业'."\n"
- .'城乡建设与工业发展 交通'."\n"
- .'自然资源与环境保护 国土资源、能源'."\n"
- .'自然资源与环境保护 土木'."\n"
- .'自然资源与环境保护 气象'."\n"
- .'自然资源与环境保护 环境保护'."\n"
- .'农林水渔牧类 农业'."\n"
- .'农林水渔牧类 林业'."\n"
- .'农林水渔牧类 水利'."\n"
- .'农林水渔牧类 渔业'."\n"
- .'农林水渔牧类 畜牧业'."\n"
- .'其他 其他'."\n",
- 'description' => '支持如下分类'."\n"
- .'| 一级分类 | 二级分类 |'."\n"
- .'| ---- | ---- |'."\n"
- .'| 国防和交流合作事务 | 国防, 对外事务, 军事工作, 港澳台侨工作 |'."\n"
- .'| 综合政务 | 二十大, 政务公开与督查, 联合政务, 党建工作, 会议及提案, 政务文件管理, 其他政务 |'."\n"
- .'| 国务院组织机构 | 国务院, 国务院办公厅, 国务院机构 |'."\n"
- .'| 行政监管与市场监管 | 行政监管, 信用监管, 产品质量监督, 安全生产监管, 市场监管 |'."\n"
- .'| 经济管理 | 国民经济, 市场经济, 经济体制改革, 国有资产监管 |'."\n"
- .'| 财政金融商贸 | 财政, 金融, 审计, 商贸, 海关 |'."\n"
- .'| 人事工作与社会保障 | 人事工作, 人口与计划生育, 妇女儿童工作, 扶贫, 减灾救灾, 公共服务, 社会福利与救助, 优抚安置, 社会保障 |'."\n"
- .'| 公共安全与社会管理 | 公安, 安全, 司法, 消防, 民族, 宗教 |'."\n"
- .'| 科教文体 | 文化, 科技创新, 教育, 知识产权, 新闻出版, 广电与互联网, 体育, 旅游 |'."\n"
- .'| 医疗卫生 | 卫生, 医疗, 动物医学 |'."\n"
- .'| 城乡建设与工业发展 | 城乡建设, 工业, 交通 |'."\n"
- .'| 自然资源与环境保护 | 国土资源、能源, 土木, 气象, 环境保护 |'."\n"
- .'| 农林水渔牧类 | 农业, 林业, 水利, 渔业, 畜牧业 |'."\n"
- .'| 其他 | 其他 |',
- 'type' => 'string',
- 'required' => false,
- 'example' => '国防和交流合作事务',
- ],
+ 'schema' => ['title' => '支持如下分类'."\n"
+ ."\n"
+ .'一级分类 二级分类'."\n"
+ .'国防和交流合作事务 国防'."\n"
+ .'国防和交流合作事务 对外事务'."\n"
+ .'国防和交流合作事务 军事工作'."\n"
+ .'国防和交流合作事务 港澳台侨工作'."\n"
+ .'综合政务 二十大'."\n"
+ .'综合政务 政务公开与督查'."\n"
+ .'综合政务 联合政务'."\n"
+ .'综合政务 党建工作'."\n"
+ .'综合政务 会议及提案'."\n"
+ .'综合政务 政务文件管理'."\n"
+ .'综合政务 其他政务'."\n"
+ .'国务院组织机构 国务院'."\n"
+ .'国务院组织机构 国务院办公厅'."\n"
+ .'国务院组织机构 国务院机构'."\n"
+ .'行政监管与市场监管 行政监管'."\n"
+ .'行政监管与市场监管 信用监管'."\n"
+ .'行政监管与市场监管 产品质量监督'."\n"
+ .'行政监管与市场监管 安全生产监管'."\n"
+ .'行政监管与市场监管 市场监管'."\n"
+ .'经济管理 国民经济'."\n"
+ .'经济管理 市场经济'."\n"
+ .'经济管理 经济体制改革'."\n"
+ .'经济管理 国有资产监管'."\n"
+ .'财政金融商贸 财政'."\n"
+ .'财政金融商贸 金融'."\n"
+ .'财政金融商贸 审计'."\n"
+ .'财政金融商贸 商贸'."\n"
+ .'财政金融商贸 海关'."\n"
+ .'人事工作与社会保障 人事工作'."\n"
+ .'人事工作与社会保障 人口与计划生育'."\n"
+ .'人事工作与社会保障 妇女儿童工作'."\n"
+ .'人事工作与社会保障 扶贫'."\n"
+ .'人事工作与社会保障 减灾救灾'."\n"
+ .'人事工作与社会保障 公共服务'."\n"
+ .'人事工作与社会保障 社会福利与救助'."\n"
+ .'人事工作与社会保障 优抚安置'."\n"
+ .'人事工作与社会保障 社会保障'."\n"
+ .'公共安全与社会管理 公安'."\n"
+ .'公共安全与社会管理 安全'."\n"
+ .'公共安全与社会管理 司法'."\n"
+ .'公共安全与社会管理 消防'."\n"
+ .'公共安全与社会管理 民族'."\n"
+ .'公共安全与社会管理 宗教'."\n"
+ .'科教文体 文化'."\n"
+ .'科教文体 科技创新'."\n"
+ .'科教文体 教育'."\n"
+ .'科教文体 知识产权'."\n"
+ .'科教文体 新闻出版'."\n"
+ .'科教文体 广电与互联网'."\n"
+ .'科教文体 体育'."\n"
+ .'科教文体 旅游'."\n"
+ .'医疗卫生 卫生'."\n"
+ .'医疗卫生 医疗'."\n"
+ .'医疗卫生 动物医学'."\n"
+ .'城乡建设与工业发展 城乡建设'."\n"
+ .'城乡建设与工业发展 工业'."\n"
+ .'城乡建设与工业发展 交通'."\n"
+ .'自然资源与环境保护 国土资源、能源'."\n"
+ .'自然资源与环境保护 土木'."\n"
+ .'自然资源与环境保护 气象'."\n"
+ .'自然资源与环境保护 环境保护'."\n"
+ .'农林水渔牧类 农业'."\n"
+ .'农林水渔牧类 林业'."\n"
+ .'农林水渔牧类 水利'."\n"
+ .'农林水渔牧类 渔业'."\n"
+ .'农林水渔牧类 畜牧业'."\n"
+ .'其他 其他'."\n", 'description' => '支持如下分类'."\n"
+ .'| 一级分类 | 二级分类 |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 国防和交流合作事务 | 国防, 对外事务, 军事工作, 港澳台侨工作 |'."\n"
+ .'| 综合政务 | 二十大, 政务公开与督查, 联合政务, 党建工作, 会议及提案, 政务文件管理, 其他政务 |'."\n"
+ .'| 国务院组织机构 | 国务院, 国务院办公厅, 国务院机构 |'."\n"
+ .'| 行政监管与市场监管 | 行政监管, 信用监管, 产品质量监督, 安全生产监管, 市场监管 |'."\n"
+ .'| 经济管理 | 国民经济, 市场经济, 经济体制改革, 国有资产监管 |'."\n"
+ .'| 财政金融商贸 | 财政, 金融, 审计, 商贸, 海关 |'."\n"
+ .'| 人事工作与社会保障 | 人事工作, 人口与计划生育, 妇女儿童工作, 扶贫, 减灾救灾, 公共服务, 社会福利与救助, 优抚安置, 社会保障 |'."\n"
+ .'| 公共安全与社会管理 | 公安, 安全, 司法, 消防, 民族, 宗教 |'."\n"
+ .'| 科教文体 | 文化, 科技创新, 教育, 知识产权, 新闻出版, 广电与互联网, 体育, 旅游 |'."\n"
+ .'| 医疗卫生 | 卫生, 医疗, 动物医学 |'."\n"
+ .'| 城乡建设与工业发展 | 城乡建设, 工业, 交通 |'."\n"
+ .'| 自然资源与环境保护 | 国土资源、能源, 土木, 气象, 环境保护 |'."\n"
+ .'| 农林水渔牧类 | 农业, 林业, 水利, 渔业, 畜牧业 |'."\n"
+ .'| 其他 | 其他 |', 'type' => 'string', 'required' => false, 'example' => '国防和交流合作事务'],
],
],
'responses' => [
@@ -20612,12 +13822,7 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
@@ -20627,112 +13832,60 @@
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Essay' => [
- 'title' => '正文',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => '文章正文',
- ],
- 'Link' => [
- 'title' => '链接',
- 'description' => '链接',
- 'type' => 'string',
- 'example' => '文章链接',
- ],
- 'IssuingAuthority' => [
- 'title' => '发布机构',
- 'description' => '发布机构',
- 'type' => 'string',
- 'example' => '发布机构',
- ],
- 'PublicationDate' => [
- 'title' => '发布日期',
- 'description' => '发布日期',
- 'type' => 'string',
- 'example' => '2023-02-01',
- ],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Essay' => ['title' => '正文', 'description' => '正文', 'type' => 'string', 'example' => '文章正文'],
+ 'Link' => ['title' => '链接', 'description' => '链接', 'type' => 'string', 'example' => '文章链接'],
+ 'IssuingAuthority' => ['title' => '发布机构', 'description' => '发布机构', 'type' => 'string', 'example' => '发布机构'],
+ 'PublicationDate' => ['title' => '发布日期', 'description' => '发布日期', 'type' => 'string', 'example' => '2023-02-01'],
],
],
'example' => 'data',
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '返回的最大记录数',
- 'description' => '返回的最大记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '71',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页Token',
- 'description' => '下一页Token',
- 'type' => 'string',
- 'example' => 'cEoBWREAXdxaOyjq/cqAbg==',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '返回的最大记录数', 'description' => '返回的最大记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '71'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页Token', 'description' => '下一页Token', 'type' => 'string', 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Title\\": \\"文章标题\\",\\n \\"Essay\\": \\"文章正文\\",\\n \\"Link\\": \\"文章链接\\",\\n \\"IssuingAuthority\\": \\"发布机构\\",\\n \\"PublicationDate\\": \\"2023-02-01\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 71,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"cEoBWREAXdxaOyjq/cqAbg==\\",\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
'title' => '公文库检索',
- ],
- 'RunTopicSelectionMerge' => [
- 'summary' => '妙策选题策划聚合',
- 'methods' => [
- 'post',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDocumentRetrieve',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"Title\\": \\"文章标题\\",\\n \\"Essay\\": \\"文章正文\\",\\n \\"Link\\": \\"文章链接\\",\\n \\"IssuingAuthority\\": \\"发布机构\\",\\n \\"PublicationDate\\": \\"2023-02-01\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 71,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"cEoBWREAXdxaOyjq/cqAbg==\\",\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 100\\n}","type":"json"}]',
+ ],
+ 'ListEnterprisePptTemplates' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -20740,211 +13893,197 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'NextToken',
'in' => 'formData',
+ 'schema' => ['title' => '下一次请求需要的token(暂未生效)', 'description' => '下一次请求需要的token(暂未生效)', 'type' => 'string', 'required' => false, 'example' => 'XXXX'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大数量(暂未生效)', 'description' => '最大数量(暂未生效)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => 'null'],
+ ],
+ [
+ 'name' => 'Skip',
+ 'in' => 'query',
+ 'schema' => ['title' => '要跳过的单个资源的数量(暂未生效)', 'description' => '要跳过的单个资源的数量(暂未生效)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '0', 'example' => '10'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '其他写作参数(prompt 和 writingParams 二选一)',
- 'description' => '自定义融合prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请从xxxx的角度,分析xxxx事件',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'description' => '文档',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'CoverImg' => ['title' => '封面图', 'description' => '封面图', 'type' => 'string', 'example' => 'http://xxx.com/a.png'],
+ ],
+ ],
+ ],
+ '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'],
+ 'Size' => ['title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NextToken' => ['title' => '下一次请求需要的token(暂未生效)', 'description' => '下一次请求需要的token(暂未生效)', 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4AACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc='],
+ 'MaxResults' => ['title' => '最大数量(暂未生效)', 'description' => '最大数量(暂未生效)', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ ],
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询企业专属PPT模板列表',
+ 'summary' => '查询企业专属PPT模板列表',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Topics',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '选题策划列表',
- 'description' => '待融合的选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '待融合的选题视角',
- 'required' => false,
- '$ref' => '#/components/schemas/TopicSelection',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListEnterprisePptTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => true,
],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Id\\": 10,\\n \\"CoverImg\\": \\"http://xxx.com/a.png\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4AACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=\\",\\n \\"MaxResults\\": 4\\n}","type":"json"}]',
+ ],
+ 'ListFreshViewPoints' => [
+ 'summary' => '新颖视角列表。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'TopicSource',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热榜源', 'description' => '热榜源', 'type' => 'string', 'required' => true, 'example' => '热榜源'],
+ ],
+ [
+ 'name' => 'Topic',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => true, 'example' => '热榜主题'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '6'],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
- 'title' => 'BaseLlmResponse',
- 'description' => 'BaseLlmResponse',
+ 'title' => 'PageResult2',
+ 'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'StatusCode' => [
- 'title' => 'http响应码',
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- 'Topic' => [
- 'description' => '融合后的选题策划对象',
- '$ref' => '#/components/schemas/TopicSelection',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '78',
- ],
- 'OutputTokens' => [
- 'description' => '输出使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '34',
- ],
- 'TokenMap' => [
- 'description' => 'token消耗明细',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
'type' => 'object',
- 'additionalProperties' => [
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '44',
- 'description' => 'token消耗量',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
],
- ],
- 'TotalTokens' => [
- 'description' => '本次调用使用的所有Token数总和',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '38',
+ 'description' => '',
],
],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
],
+ 'description' => '',
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'End' => [
- 'description' => '响应包是否结束',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '94'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '26'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取新颖视角列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListFreshViewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\",\\n \\"Topic\\": {\\n \\"Point\\": \\"\\",\\n \\"Summary\\": \\"\\",\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"\\",\\n \\"Summary\\": \\"\\"\\n }\\n ]\\n }\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 78,\\n \\"OutputTokens\\": 34,\\n \\"TokenMap\\": {\\n \\"key\\": 44\\n },\\n \\"TotalTokens\\": 38\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true\\n}","type":"json"}]',
- 'title' => '选题热点融合',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 94,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 26\\n}","type":"json"}]',
],
- 'GenerateViewPoint' => [
- 'summary' => '生成选题视角。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'ListGeneralConfigs' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -20952,123 +14091,273 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-'],
],
[
- 'name' => 'ReferenceData',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页:默认1', 'description' => '当前页:默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '引用的上下文数据',
- 'description' => '引用的上下文数据',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'MiniDoc' => [
- 'title' => '传入的文章片段。',
- 'description' => '传入的文章片段。',
+ 'Data' => [
+ 'title' => '查询结果',
+ 'description' => '查询结果',
'type' => 'array',
'items' => [
- 'description' => '文章片段',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章片段',
+ 'title' => '查询结果',
+ 'description' => '查询结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConfigKey' => ['title' => '配置项唯一标识', 'description' => '配置项唯一标识', 'type' => 'string', 'example' => 'xxx'],
+ 'ConfigValue' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'example' => 'xxx'],
+ 'ConfigValueType' => ['title' => '配置项类型', 'description' => '配置项类型', 'type' => 'string', 'example' => 'CustomSemanticSearch'],
+ 'ConfigDesc' => ['title' => '配置项说明', 'description' => '配置项说明', 'type' => 'string', 'example' => 'xxx'],
+ ],
],
- 'required' => false,
],
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TotalCount' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'PageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通用配置-列表',
+ 'summary' => '通用配置-列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListGeneralConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"ConfigKey\\": \\"xxx\\",\\n \\"ConfigValue\\": \\"xxx\\",\\n \\"ConfigValueType\\": \\"CustomSemanticSearch\\",\\n \\"ConfigDesc\\": \\"xxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10\\n}","type":"json"}]',
+ ],
+ 'ListGeneratedContents' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务标识', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'task-03d46184ee7d8749'],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-04 11:46:07'],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['description' => '结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-04 11:46:07'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['title' => '标题:支持模糊搜索', 'description' => '标题内容', 'type' => 'string', 'required' => false, 'example' => '杭州亚运会'],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['title' => '搜索关键词:支持标题和正文模糊搜索', 'description' => '搜索关键词:支持标题和正文模糊搜索', 'type' => 'string', 'required' => false, 'example' => '检索Query'],
+ ],
+ [
+ 'name' => 'ContentDomain',
+ 'in' => 'formData',
+ 'schema' => [
+ 'description' => '内容领域(创作类型的分类)'."\n"
+ .' - media: 传媒写作'."\n"
+ .'- government: 政府公文写作'."\n"
+ .'- office:办公写作'."\n"
+ .'- market:营销写作'."\n"
+ .'- custom: 自定义写作'."\n"
+ .'- commentGenerate: 观点生成',
+ 'type' => 'string',
'required' => false,
+ 'enumValueTitles' => ['market' => '营销写作', 'government' => '政务', 'custom' => '自定义写作', 'media' => '传媒', 'office' => '办公写作', 'commentGenerate' => '观点生成'],
+ 'example' => 'media',
+ 'default' => 'media',
+ 'enum' => [],
],
],
+ [
+ 'name' => 'Current',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'formData',
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'DataType',
+ 'in' => 'formData',
+ 'schema' => ['description' => '数据类型筛选'."\n"
+ ."\n"
+ .'- plainText:纯文本'."\n"
+ .'- richText:富文本'."\n"
+ .'- html:网页'."\n"
+ .'- pdf:PDF'."\n"
+ .'- word:WORD'."\n"
+ .'- excel:excel'."\n"
+ .'- csv:CSV'."\n"
+ .'- image:图片'."\n"
+ .'- video:视频'."\n"
+ .'- audio:音频', 'type' => 'string', 'required' => false, 'example' => 'plainText'],
+ ],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'description' => '文档列表',
'type' => 'array',
'items' => [
- 'description' => '生成的视角',
+ 'description' => '文档',
'type' => 'object',
'properties' => [
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
+ 'Content' => ['title' => '正文:富文本', 'description' => '正文:富文本', 'type' => 'string', 'example' => '杭州亚运会'],
+ 'ContentDomain' => ['title' => '内容生成的领域-media:新闻、government:政务', 'description' => '内容领域(创作类型的分类)'."\n"
+ .' - media: 传媒写作'."\n"
+ .'- government: 政府公文写作'."\n"
+ .'- office:办公写作'."\n"
+ .'- market:营销写作'."\n"
+ .'- custom: 自定义写作'."\n"
+ .'- commentGenerate: 观点生成', 'type' => 'string', 'example' => 'media'],
+ 'ContentText' => ['title' => '正文:纯文本', 'description' => '正文:纯文本', 'type' => 'string', 'example' => '杭州亚运会'],
+ 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2024-01-04 11:46:07'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '"123"'],
+ 'DeviceId' => ['title' => '设备ID', 'description' => '设备ID', 'type' => 'string', 'example' => 'xxx'],
+ 'Id' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'KeywordList' => [
+ 'title' => '关键词',
+ 'description' => '关键词',
+ 'type' => 'array',
+ 'items' => ['description' => '关键词', 'type' => 'string', 'example' => '观点'],
+ ],
+ 'Keywords' => ['title' => '关键词(string)', 'description' => '关键词(string)', 'type' => 'string', 'example' => '观点'],
+ 'Prompt' => ['title' => '最后一次生成的提示词', 'description' => '最后一次生成的提示词', 'type' => 'string', 'example' => '创作xxx文章'],
+ 'TaskId' => ['title' => '会话任务唯一标识', 'description' => '会话任务唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '杭州亚运会'],
+ 'UpdateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2024-01-04 11:46:07'],
+ 'UpdateUser' => ['title' => '更新者', 'description' => '更新者', 'type' => 'string', 'example' => '"1111"'],
+ 'Uuid' => ['title' => 'UUID 溯源唯一标识', 'description' => 'UUID 溯源唯一标识', 'type' => 'string', 'example' => 'xxx'],
+ 'FileKey' => ['description' => '文件唯一标识', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
+ 'FileAttr' => [
+ 'description' => '文件属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileName' => ['description' => '文件名称', 'type' => 'string', 'example' => 'homedepothp.txt'],
+ 'Width' => ['description' => '视频宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '800'],
+ 'TmpUrl' => ['description' => '视频文件临时访问URL。1小时过期', 'type' => 'string', 'example' => 'http://www.example.com/xxx.mp4'],
+ 'Height' => ['description' => '视频高度', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ ],
],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ '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'],
+ 'Size' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取文档列表',
+ 'summary' => '获取文档列表:用来查询妙笔中创作的文章历史列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-12T06:20:11.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-09-18T03:28:07.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-09-18T03:28:07.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-31T03:59:14.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Data\\": [\\n {\\n \\"Point\\": \\"视角\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '生成选题视角',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListGeneratedContents'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListGeneratedContents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Content\\": \\"杭州亚运会\\",\\n \\"ContentDomain\\": \\"media\\",\\n \\"ContentText\\": \\"杭州亚运会\\",\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"CreateUser\\": \\"\\\\\\"123\\\\\\"\\",\\n \\"DeviceId\\": \\"xxx\\",\\n \\"Id\\": 10,\\n \\"KeywordList\\": [\\n \\"观点\\"\\n ],\\n \\"Keywords\\": \\"观点\\",\\n \\"Prompt\\": \\"创作xxx文章\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Title\\": \\"杭州亚运会\\",\\n \\"UpdateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"UpdateUser\\": \\"\\\\\\"1111\\\\\\"\\",\\n \\"Uuid\\": \\"xxx\\",\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"homedepothp.txt\\",\\n \\"Width\\": 800,\\n \\"TmpUrl\\": \\"http://www.example.com/xxx.mp4\\",\\n \\"Height\\": 500\\n }\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
],
'ListHotNewsWithType' => [
'summary' => '获取选题热点列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -21076,22 +14365,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~3027170~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
],
[
'name' => 'NewsType',
@@ -21102,11 +14381,7 @@
'type' => 'string',
'required' => false,
'example' => 'society',
- 'enum' => [
- 'society',
- 'person',
- 'government',
- ],
+ 'enum' => ['society', 'person', 'government'],
],
],
[
@@ -21117,36 +14392,19 @@
'title' => '新闻类别列表多选。society: 社会时事,person: 人物新闻,government: 党政时事',
'description' => '新闻类别列表多选。society: 社会时事,person: 人物新闻,government: 党政时事',
'type' => 'array',
- 'items' => [
- 'description' => '新闻类别',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'society',
- ],
+ 'items' => ['description' => '新闻类别', 'type' => 'string', 'required' => false, 'example' => 'society'],
'required' => false,
],
],
[
'name' => 'Size',
'in' => 'formData',
- 'schema' => [
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
'name' => 'Current',
'in' => 'formData',
- 'schema' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
@@ -21156,12 +14414,7 @@
'description' => 'PlainResult<List<HotNewsWithType>>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
@@ -21176,158 +14429,74 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者名称',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '新闻内容',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者名称'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '新闻内容'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
'ImageUrls' => [
'title' => '图片地址',
'description' => '图片地址',
'type' => 'array',
- 'items' => [
- 'description' => '新闻图像的URL。',
- 'type' => 'string',
- 'example' => 'http://www.example.com/a.jpg',
- ],
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2023-04-11 06:14:07',
- ],
- 'SearchSource' => [
- 'title' => '搜索源',
- 'description' => '搜索源',
- 'type' => 'string',
- 'example' => '新浪热榜',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索源名称',
- 'description' => '搜索源名称',
- 'type' => 'string',
- 'example' => '新浪热榜',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '新浪新闻综合',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '社会',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '新闻标题',
- ],
- 'UpdateTime' => [
- 'title' => '系统更新时间',
- 'description' => '系统更新时间',
- 'type' => 'string',
- 'example' => '2023-10-14 14:30:00',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/a.html',
+ 'items' => ['description' => '新闻图像的URL。', 'type' => 'string', 'example' => 'http://www.example.com/a.jpg'],
],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2023-04-11 06:14:07'],
+ 'SearchSource' => ['title' => '搜索源', 'description' => '搜索源', 'type' => 'string', 'example' => '新浪热榜'],
+ 'SearchSourceName' => ['title' => '搜索源名称', 'description' => '搜索源名称', 'type' => 'string', 'example' => '新浪热榜'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '新浪新闻综合'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => '社会'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '新闻标题'],
+ 'UpdateTime' => ['title' => '系统更新时间', 'description' => '系统更新时间', 'type' => 'string', 'example' => '2023-10-14 14:30:00'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'http://www.example.com/a.html'],
],
+ 'description' => '',
],
],
- 'NewsType' => [
- 'title' => '新闻类别。society: 社会时事,person: 人物新闻,government: 党政时事',
- 'description' => '新闻类别。society: 社会时事,person: 人物新闻,government: 党政时事',
- 'type' => 'string',
- 'example' => 'society',
- ],
- 'NewsTypeName' => [
- 'title' => '新闻类别名称',
- 'description' => '新闻类别名称',
- 'type' => 'string',
- 'example' => '社会时事',
- ],
- 'TotalPages' => [
- 'title' => '总页数',
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '77',
- ],
+ 'NewsType' => ['title' => '新闻类别。society: 社会时事,person: 人物新闻,government: 党政时事', 'description' => '新闻类别。society: 社会时事,person: 人物新闻,government: 党政时事', 'type' => 'string', 'example' => 'society'],
+ 'NewsTypeName' => ['title' => '新闻类别名称', 'description' => '新闻类别名称', 'type' => 'string', 'example' => '社会时事'],
+ 'TotalPages' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '77'],
],
+ 'description' => '',
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"News\\": [\\n {\\n \\"Author\\": \\"作者名称\\",\\n \\"Content\\": \\"新闻内容\\",\\n \\"DocUuid\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"ImageUrls\\": [\\n \\"http://www.example.com/a.jpg\\"\\n ],\\n \\"PubTime\\": \\"2023-04-11 06:14:07\\",\\n \\"SearchSource\\": \\"新浪热榜\\",\\n \\"SearchSourceName\\": \\"新浪热榜\\",\\n \\"Source\\": \\"新浪新闻综合\\",\\n \\"Summary\\": \\"摘要\\",\\n \\"Tag\\": \\"社会\\",\\n \\"Title\\": \\"新闻标题\\",\\n \\"UpdateTime\\": \\"2023-10-14 14:30:00\\",\\n \\"Url\\": \\"http://www.example.com/a.html\\"\\n }\\n ],\\n \\"NewsType\\": \\"society\\",\\n \\"NewsTypeName\\": \\"社会时事\\",\\n \\"TotalPages\\": 77\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
'title' => '获取选题热点列表',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListHotNewsWithType'],
+ ],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotNewsWithType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
],
'ListHotSources' => [
- 'summary' => '获取所有平台热榜源列表。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -21335,64 +14504,32 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '66',
- ],
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '66'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'PageResult2',
'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'description' => '三方源列表',
'type' => 'array',
@@ -21400,94 +14537,50 @@
'description' => '三方源对象',
'type' => 'object',
'properties' => [
- 'Description' => [
- 'title' => '热榜源描述',
- 'description' => '热榜源描述',
- 'type' => 'string',
- 'example' => '热榜源描述',
- ],
- 'Show' => [
- 'description' => '是否控制台展示',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Sort' => [
- 'title' => '排序值',
- 'description' => '排序值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '86',
- ],
- 'Source' => [
- 'title' => '热榜源标识',
- 'description' => '热榜源标识',
- 'type' => 'string',
- 'example' => '热榜源标识',
- ],
+ 'Description' => ['title' => '热榜源描述', 'description' => '热榜源描述', 'type' => 'string', 'example' => '热榜源描述'],
+ 'Show' => ['description' => '是否控制台展示', 'type' => 'boolean', 'example' => 'true'],
+ 'Sort' => ['title' => '排序值', 'description' => '排序值', 'type' => 'integer', 'format' => 'int32', 'example' => '86'],
+ 'Source' => ['title' => '热榜源标识', 'description' => '热榜源标识', 'type' => 'string', 'example' => '热榜源标识'],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'description' => '返回的最大结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '4',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'description' => '下一页Token',
- 'type' => 'string',
- 'example' => 'xxxxxx',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['description' => '返回的最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '4'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['description' => '下一页Token', 'type' => 'string', 'example' => 'xxxxxx'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '30'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取三方热榜源列表',
+ 'summary' => '获取所有平台热榜源列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotSources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Description\\": \\"热榜源描述\\",\\n \\"Show\\": true,\\n \\"Sort\\": 86,\\n \\"Source\\": \\"热榜源标识\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 4,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"xxxxxx\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 30\\n}","type":"json"}]',
- 'title' => '获取三方热榜源列表',
],
'ListHotTopics' => [
- 'summary' => '获取热点话题列表。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -21495,37 +14588,19 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源筛选,支持的热榜源。热榜源详见API:ListHotSources',
- 'description' => '热榜源筛选,支持的热榜源。热榜源详见API:ListHotSources'."\n"
- ."\n"
- .'Aggregation:表示 聚合后的全国热点话题榜',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Quark',
- ],
+ 'schema' => ['title' => '热榜源筛选,支持的热榜源。热榜源详见API:ListHotSources', 'description' => '热榜源筛选,支持的热榜源。热榜源详见API:ListHotSources'."\n"
+ ."\n"
+ .'Aggregation:表示 聚合后的全国热点话题榜', 'type' => 'string', 'required' => false, 'example' => 'Quark'],
],
[
'name' => 'Topics',
@@ -21535,37 +14610,19 @@
'title' => '热榜主题事件筛选',
'description' => '热榜主题事件筛选',
'type' => 'array',
- 'items' => [
- 'title' => '热榜主题事件名称',
- 'description' => '热榜主题事件名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'items' => ['title' => '热榜主题事件名称', 'description' => '热榜主题事件名称', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
'required' => false,
],
],
[
'name' => 'TopicVersion',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据版本筛选',
- 'description' => '数据版本筛选',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数据版本筛选',
- ],
+ 'schema' => ['title' => '数据版本筛选', 'description' => '数据版本筛选', 'type' => 'string', 'required' => false, 'example' => '数据版本筛选'],
],
[
'name' => 'TopicQuery',
'in' => 'formData',
- 'schema' => [
- 'title' => '根据热榜主题全文检索',
- 'description' => '根据热榜主题全文检索',
- 'type' => 'string',
- 'required' => false,
- 'example' => '根据热榜主题全文检索',
- ],
+ 'schema' => ['title' => '根据热榜主题全文检索', 'description' => '根据热榜主题全文检索', 'type' => 'string', 'required' => false, 'example' => '根据热榜主题全文检索'],
],
[
'name' => 'TopicIds',
@@ -21575,66 +14632,49 @@
'title' => '热榜主题ID列表',
'description' => '热榜主题ID列表',
'type' => 'array',
- 'items' => [
- 'title' => '热榜主题ID',
- 'description' => '热榜主题ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxxx',
- ],
+ 'items' => ['title' => '热榜主题ID', 'description' => '热榜主题ID', 'type' => 'string', 'required' => false, 'example' => 'xxxxxx'],
'required' => false,
],
],
[
'name' => 'WithNews',
'in' => 'formData',
- 'schema' => [
- 'title' => '响应是否包含新闻',
- 'description' => '响应是否包含新闻',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '响应是否包含新闻', 'description' => '响应是否包含新闻', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '1',
- ],
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'],
+ ],
+ [
+ 'name' => 'CustomField',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义业务字段筛选(keyword 精确匹配),长度上限 255 字符', 'description' => '自定义业务字段筛选(keyword 精确匹配),长度上限 255 字符', 'type' => 'string', 'required' => false, 'example' => 'biz-tag-001', 'maxLength' => 255],
+ ],
+ [
+ 'name' => 'CreateTimeStart',
+ 'in' => 'formData',
+ 'schema' => ['title' => '话题创建时间筛选起点(包含),格式:yyyy-MM-dd HH:mm:ss', 'description' => '话题创建时间筛选起点(包含),格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2026-06-01 00:00:00'],
+ ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'formData',
+ 'schema' => ['title' => '话题创建时间筛选终点(包含),格式:yyyy-MM-dd HH:mm:ss', 'description' => '话题创建时间筛选终点(包含),格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2026-06-04 23:59:59'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'PageResult2',
'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
@@ -21643,44 +14683,16 @@
'description' => '热点事件列表',
'type' => 'object',
'properties' => [
- 'AsyncTaskId' => [
- 'title' => '异步任务ID(自定义主题场景下使用)',
- 'description' => '异步任务ID(自定义主题场景下使用)',
- 'type' => 'string',
- 'example' => '异步任务ID(自定义主题场景下使用)',
- ],
- 'CreateUser' => [
- 'title' => '创建用户ID(自定义主题场景下使用)',
- 'description' => '创建用户ID(自定义主题场景下使用)',
- 'type' => 'string',
- 'example' => '创建用户ID(自定义主题场景下使用)',
- ],
- 'HotValue' => [
- 'title' => '热度值',
- 'description' => '热度值',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '61',
- ],
- 'Id' => [
- 'title' => '热榜ID',
- 'description' => '热榜ID',
- 'type' => 'string',
- 'example' => '热榜ID',
- ],
+ 'AsyncTaskId' => ['title' => '异步任务ID(自定义主题场景下使用)', 'description' => '异步任务ID(自定义主题场景下使用)', 'type' => 'string', 'example' => '异步任务ID(自定义主题场景下使用)'],
+ 'CreateUser' => ['title' => '创建用户ID(自定义主题场景下使用)', 'description' => '创建用户ID(自定义主题场景下使用)', 'type' => 'string', 'example' => '创建用户ID(自定义主题场景下使用)'],
+ 'HotValue' => ['title' => '热度值', 'description' => '热度值', 'type' => 'integer', 'format' => 'int64', 'example' => '61'],
+ 'Id' => ['title' => '热榜ID', 'description' => '热榜ID', 'type' => 'string', 'example' => '热榜ID'],
'Status' => [
'title' => '异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
'description' => '异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
'type' => 'string',
'example' => 'FAILED',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
- ],
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'],
],
'StructureSummary' => [
'title' => '结构化主题摘要列表',
@@ -21696,328 +14708,24 @@
'items' => [
'type' => 'object',
'properties' => [
- 'Source' => [
- 'description' => '文章来源',
- 'type' => 'string',
- 'example' => '夸克',
- ],
- 'Title' => [
- 'description' => '文章标题',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'Url' => [
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com',
- ],
- ],
- ],
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- ],
- ],
- ],
- 'Summary' => [
- 'title' => '热榜摘要',
- 'description' => '热榜摘要',
- 'type' => 'string',
- 'example' => '热榜摘要',
- ],
- 'TaskErrorMessage' => [
- 'title' => '异步任务失败错误信息',
- 'description' => '异步任务失败错误信息',
- 'type' => 'string',
- 'example' => '异步任务失败错误信息',
- ],
- 'TaskStatus' => [
- 'title' => '异步任务状态.0-待执行,1-执行中,2-执行成功 3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)',
- 'description' => '异步任务状态。0-待执行,1-执行中,2-执行成功,3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '26',
- ],
- 'Topic' => [
- 'title' => '主题唯一名称',
- 'description' => '主题唯一名称',
- 'type' => 'string',
- 'example' => '主题唯一名称',
- ],
- 'TopicSource' => [
- 'title' => '热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜',
- 'description' => '热榜源,目前支持的热榜源:'."\n"
- ."\n"
- .'- Toutiao:头条'."\n"
- ."\n"
- .'- Quark:夸克'."\n"
- ."\n"
- .'- Baidu:百度'."\n"
- ."\n"
- .'- Sina:新浪'."\n"
- ."\n"
- .'- Custom:自定义'."\n"
- ."\n"
- .'- Aggregation:热点话题榜',
- 'type' => 'string',
- 'example' => 'Toutiao',
- ],
- 'Version' => [
- 'title' => '数据版本',
- 'description' => '数据版本',
- 'type' => 'string',
- 'example' => '数据版本',
- ],
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '94',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '23',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"AsyncTaskId\\": \\"异步任务ID(自定义主题场景下使用)\\",\\n \\"CreateUser\\": \\"创建用户ID(自定义主题场景下使用)\\",\\n \\"HotValue\\": 61,\\n \\"Id\\": \\"热榜ID\\",\\n \\"Status\\": \\"FAILED\\",\\n \\"StructureSummary\\": [\\n {\\n \\"DocList\\": [\\n {\\n \\"Source\\": \\"夸克\\",\\n \\"Title\\": \\"xxxxx\\",\\n \\"Url\\": \\"http://www.example.com\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ],\\n \\"Summary\\": \\"热榜摘要\\",\\n \\"TaskErrorMessage\\": \\"异步任务失败错误信息\\",\\n \\"TaskStatus\\": 26,\\n \\"Topic\\": \\"主题唯一名称\\",\\n \\"TopicSource\\": \\"Toutiao\\",\\n \\"Version\\": \\"数据版本\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 94,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
- 'title' => '获取热点话题列表',
- ],
- 'GetTopicById' => [
- 'summary' => '根据ID获取热点事件信息。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'Id',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '数据ID',
- 'description' => '数据ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '数据ID',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'AsyncTaskId' => [
- 'title' => '异步任务ID(自定义主题场景下使用)',
- 'description' => '异步任务ID(自定义主题场景下使用)',
- 'type' => 'string',
- 'example' => '异步任务ID(自定义主题场景下使用)',
- ],
- 'CreateUser' => [
- 'title' => '创建用户ID(自定义主题场景下使用)',
- 'description' => '创建用户ID(自定义主题场景下使用)',
- 'type' => 'string',
- 'example' => '创建用户ID(自定义主题场景下使用)',
- ],
- 'HotValue' => [
- 'title' => '热度值',
- 'description' => '热度值',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '43',
- ],
- 'Id' => [
- 'title' => '热榜ID',
- 'description' => '热榜ID',
- 'type' => 'string',
- 'example' => '热榜ID',
- ],
- 'Status' => [
- 'title' => '异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'description' => '异步任务状态(自定义事件场景下使用) (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'type' => 'string',
- 'example' => 'PENDING',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
- ],
- ],
- 'StructureSummary' => [
- 'title' => '结构化主题摘要列表',
- 'description' => '结构化主题摘要列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '结构化主题摘要对象',
- 'type' => 'object',
- 'properties' => [
- 'DocList' => [
- 'title' => '生成该标题摘要引用的文章',
- 'description' => '生成该标题摘要引用的文章',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章对象',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'description' => '文章源',
- 'type' => 'string',
- 'example' => '头条',
- ],
- 'Title' => [
- 'description' => '文章标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Url' => [
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com',
+ 'Source' => ['description' => '文章来源', 'type' => 'string', 'example' => '夸克'],
+ 'Title' => ['description' => '文章标题', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Url' => ['description' => '文章URL', 'type' => 'string', 'example' => 'http://www.example.com'],
],
+ 'description' => '',
],
],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
+ 'description' => '',
],
],
- ],
- 'Summary' => [
- 'title' => '热榜摘要',
- 'description' => '热榜摘要',
- 'type' => 'string',
- 'example' => '热榜摘要',
- ],
- 'TaskErrorMessage' => [
- 'title' => '异步任务失败错误信息',
- 'description' => '异步任务失败错误信息',
- 'type' => 'string',
- 'example' => '异步任务失败错误信息',
- ],
- 'TaskStatus' => [
- 'title' => '异步任务状态.0-待执行,1-执行中,2-执行成功 3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)',
- 'description' => '异步任务状态。0-待执行,1-执行中,2-执行成功,3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '14',
- ],
- 'Topic' => [
- 'title' => '主题唯一名称',
- 'description' => '主题唯一名称',
- 'type' => 'string',
- 'example' => '主题唯一名称',
- ],
- 'TopicSource' => [
- 'title' => '热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜',
- 'description' => '热榜源,目前支持的热榜源:'."\n"
+ 'Summary' => ['title' => '热榜摘要', 'description' => '热榜摘要', 'type' => 'string', 'example' => '热榜摘要'],
+ 'TaskErrorMessage' => ['title' => '异步任务失败错误信息', 'description' => '异步任务失败错误信息', 'type' => 'string', 'example' => '异步任务失败错误信息'],
+ 'TaskStatus' => ['title' => '异步任务状态.0-待执行,1-执行中,2-执行成功 3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)', 'description' => '异步任务状态。0-待执行,1-执行中,2-执行成功,3-暂停(暂不使用),4-执行失败,6-任务取消(自定义事件场景下使用)', 'type' => 'integer', 'format' => 'int32', 'example' => '26'],
+ 'Topic' => ['title' => '主题唯一名称', 'description' => '主题唯一名称', 'type' => 'string', 'example' => '主题唯一名称'],
+ 'TopicSource' => ['title' => '热榜源,目前支持的热榜源: Toutiao:头条、Quark:夸克、Baidu:百度、Sina:新浪。Custom:自定义、Aggregation:热点话题榜', 'description' => '热榜源,目前支持的热榜源:'."\n"
."\n"
.'- Toutiao:头条'."\n"
."\n"
@@ -22029,62 +14737,51 @@
."\n"
.'- Custom:自定义'."\n"
."\n"
- .'- Aggregation:热点话题榜',
- 'type' => 'string',
- 'example' => 'Toutiao',
- ],
- 'Version' => [
- 'title' => '数据版本',
- 'description' => '数据版本',
- 'type' => 'string',
- 'example' => '数据版本',
+ .'- Aggregation:热点话题榜', 'type' => 'string', 'example' => 'Toutiao'],
+ 'Version' => ['title' => '数据版本', 'description' => '数据版本', 'type' => 'string', 'example' => '数据版本'],
+ 'CustomField' => ['title' => '自定义业务字段(keyword)', 'description' => '自定义业务字段(keyword)', 'type' => 'string', 'example' => 'biz-tag-001'],
+ 'CreateTime' => ['title' => '话题创建时间,格式:yyyy-MM-dd HH:mm:ss', 'description' => '话题创建时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2026-06-04 12:34:56'],
+ 'TopicUrl' => ['title' => '话题原文链接', 'description' => '话题原文链接', 'type' => 'string', 'example' => 'https://www.example.com/topic/123'],
],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '94'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '23'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取热点话题列表',
+ 'summary' => '获取热点话题列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"AsyncTaskId\\": \\"异步任务ID(自定义主题场景下使用)\\",\\n \\"CreateUser\\": \\"创建用户ID(自定义主题场景下使用)\\",\\n \\"HotValue\\": 43,\\n \\"Id\\": \\"热榜ID\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"StructureSummary\\": [\\n {\\n \\"DocList\\": [\\n {\\n \\"Source\\": \\"头条\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"http://www.example.com\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ],\\n \\"Summary\\": \\"热榜摘要\\",\\n \\"TaskErrorMessage\\": \\"异步任务失败错误信息\\",\\n \\"TaskStatus\\": 14,\\n \\"Topic\\": \\"主题唯一名称\\",\\n \\"TopicSource\\": \\"Toutiao\\",\\n \\"Version\\": \\"数据版本\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取热点对象',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotTopics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"AsyncTaskId\\": \\"异步任务ID(自定义主题场景下使用)\\",\\n \\"CreateUser\\": \\"创建用户ID(自定义主题场景下使用)\\",\\n \\"HotValue\\": 61,\\n \\"Id\\": \\"热榜ID\\",\\n \\"Status\\": \\"FAILED\\",\\n \\"StructureSummary\\": [\\n {\\n \\"DocList\\": [\\n {\\n \\"Source\\": \\"夸克\\",\\n \\"Title\\": \\"xxxxx\\",\\n \\"Url\\": \\"http://www.example.com\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ],\\n \\"Summary\\": \\"热榜摘要\\",\\n \\"TaskErrorMessage\\": \\"异步任务失败错误信息\\",\\n \\"TaskStatus\\": 26,\\n \\"Topic\\": \\"主题唯一名称\\",\\n \\"TopicSource\\": \\"Toutiao\\",\\n \\"Version\\": \\"数据版本\\",\\n \\"CustomField\\": \\"biz-tag-001\\",\\n \\"CreateTime\\": \\"2026-06-04 12:34:56\\",\\n \\"TopicUrl\\": \\"https://www.example.com/topic/123\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 94,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 23\\n}","type":"json"}]',
],
'ListHotViewPoints' => [
- 'summary' => '热门视角列表。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -22092,86 +14789,42 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源',
- 'description' => '热榜源',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜源',
- ],
+ 'schema' => ['title' => '热榜源', 'description' => '热榜源', 'type' => 'string', 'required' => true, 'example' => '热榜源'],
],
[
'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜主题',
- ],
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => true, 'example' => '热榜主题'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '56',
- ],
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '56'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'PageResult2',
'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
@@ -22180,18 +14833,8 @@
'description' => '观点对象',
'type' => 'object',
'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
'News' => [
'title' => '相关新闻列表',
'description' => '相关新闻列表',
@@ -22200,96 +14843,34 @@
'description' => '文章对象',
'type' => 'object',
'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'description' => '文章外部唯一标识',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'DocUuid' => [
- 'title' => '文章唯一ID',
- 'description' => '文章唯一ID',
- 'type' => 'string',
- 'example' => '123456',
- ],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'DocId' => ['description' => '文章外部唯一标识', 'type' => 'string', 'example' => 'xxxxx'],
+ 'DocUuid' => ['title' => '文章唯一ID', 'description' => '文章唯一ID', 'type' => 'string', 'example' => '123456'],
'ImageUrls' => [
'title' => '文章配图URL',
'description' => '文章配图URL',
'type' => 'array',
- 'items' => [
- 'description' => '图片链接',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.png',
- ],
+ 'items' => ['description' => '图片链接', 'type' => 'string', 'example' => 'https://www.example.com/aaa.png'],
'example' => 'https://www.example.com/aaa.png',
],
- 'PubTime' => [
- 'title' => '发布时间。格式:YYYY-MM-dd HH:mm:ss',
- 'description' => '发布时间。格式:YYYY-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2024-01-22 10:29:00',
- ],
- 'Source' => [
- 'title' => '文章来源',
- 'description' => '文章来源',
- 'type' => 'string',
- 'example' => '新浪',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
+ 'PubTime' => ['title' => '发布时间。格式:YYYY-MM-dd HH:mm:ss', 'description' => '发布时间。格式:YYYY-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-01-22 10:29:00'],
+ 'Source' => ['title' => '文章来源', 'description' => '文章来源', 'type' => 'string', 'example' => '新浪'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '文章摘要'],
'Tags' => [
'title' => '标签',
'description' => '标签',
'type' => 'array',
- 'items' => [
- 'description' => '文章标签',
- 'type' => 'string',
- 'example' => '["标签1","标签2"]',
- ],
+ 'items' => ['description' => '文章标签', 'type' => 'string', 'example' => '["标签1","标签2"]'],
'example' => '["标签1","标签2"]',
],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Topic' => [
- 'title' => '文章主题',
- 'description' => '文章主题',
- 'type' => 'string',
- 'example' => '文章主题',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Topic' => ['title' => '文章主题', 'description' => '文章主题', 'type' => 'string', 'example' => '文章主题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
],
],
],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
'ViewPoints' => [
'title' => '选题视角列表',
'description' => '选题视角列表',
@@ -22305,103 +14886,56 @@
'description' => '大纲对象',
'type' => 'object',
'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
],
],
],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
],
+ 'description' => '',
],
],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '67',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '70',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '67'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '70'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"News\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"xxxxx\\",\\n \\"DocUuid\\": \\"123456\\",\\n \\"ImageUrls\\": [\\n \\"https://www.example.com/aaa.png\\"\\n ],\\n \\"PubTime\\": \\"2024-01-22 10:29:00\\",\\n \\"Source\\": \\"新浪\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"标签1\\\\\\",\\\\\\"标签2\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"文章标题\\",\\n \\"Topic\\": \\"文章主题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 67,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 70\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '获取热门视角列表',
- ],
- 'ListTimedViewAttitude' => [
- 'summary' => '时效性视角列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'summary' => '热门视角列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotViewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"News\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"xxxxx\\",\\n \\"DocUuid\\": \\"123456\\",\\n \\"ImageUrls\\": [\\n \\"https://www.example.com/aaa.png\\"\\n ],\\n \\"PubTime\\": \\"2024-01-22 10:29:00\\",\\n \\"Source\\": \\"新浪\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"标签1\\\\\\",\\\\\\"标签2\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"文章标题\\",\\n \\"Topic\\": \\"文章主题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 67,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 70\\n}","type":"json"}]',
+ ],
+ 'ListInterveneCnt' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -22409,249 +14943,180 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public'],
],
[
- 'name' => 'TopicSource',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源',
- 'description' => '热榜源',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜源',
- ],
+ 'schema' => ['title' => '页面尺寸', 'description' => '页面尺寸', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'Topic',
+ 'name' => 'PageIndex',
'in' => 'formData',
+ 'schema' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜主题',
+ 'title' => 'PlainResult<GetIntervenesCntListResult>',
+ 'description' => 'PlainResult<GetIntervenesCntListResult>',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'CntList' => [
+ 'title' => '数量信息列表',
+ 'description' => '数量信息列表',
+ 'type' => 'array',
+ 'items' => ['description' => '分类数量信息', 'type' => 'any', 'example' => '{'."\n"
+ .'"namespace":"namespace_qa_query", '."\n"
+ .'"interfereType":0,'."\n"
+ .'"cnt": 10'."\n"
+ .'}'],
+ ],
+ 'PageCnt' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'PageIndex' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '页尺寸', 'description' => '页尺寸', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Code' => ['description' => '干预服务状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
+ ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
+ ],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获得所有干预项的数量',
+ 'summary' => '获得干预项目数量列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListInterveneCnt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"CntList\\": [\\n \\"{\\\\n\\\\\\"namespace\\\\\\":\\\\\\"namespace_qa_query\\\\\\", \\\\n\\\\\\"interfereType\\\\\\":0,\\\\n\\\\\\"cnt\\\\\\": 10\\\\n}\\"\\n ],\\n \\"PageCnt\\": 10,\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListInterveneImportTasks' => [
+ 'summary' => '获得导入任务列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'NextToken',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'PageIndex',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的Token',
- ],
+ 'schema' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '53',
- ],
+ 'schema' => ['title' => '每页尺寸', 'description' => '每页尺寸', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
- 'title' => 'PageResult2',
- 'description' => 'PageResult2',
+ 'title' => 'PlainResult<OperationStatusListResult>',
+ 'description' => 'PlainResult<OperationStatusListResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '时效性观点对象',
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-01-22 10:29',
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
- 'Source' => [
- 'title' => '新闻来源',
- 'description' => '新闻来源',
- 'type' => 'string',
- 'example' => '新浪',
- ],
- 'Title' => [
- 'title' => '当前观点 等价于 新闻标题',
- 'description' => '当前观点,等价于新闻标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'title' => '新闻URL',
- 'description' => '新闻URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/news/1.html',
- ],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '视角对象',
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
+ 'type' => 'object',
+ 'properties' => [
+ 'PageIndex' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '页尺寸', 'description' => '页尺寸', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'StatusList' => [
+ 'title' => '任务状态信息',
+ 'description' => '任务状态信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Msg' => ['title' => '任务信息', 'description' => '任务信息', 'type' => 'string', 'example' => 'Success'],
+ 'Percentage' => ['title' => '完成百分比', 'description' => '完成百分比', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'Status' => ['title' => '任务状态', 'description' => '任务状态', 'type' => 'integer', 'format' => 'int32', 'example' => 'Success'],
+ 'TaskId' => ['title' => '任务Id', 'description' => '任务Id', 'type' => 'string', 'example' => '4854'],
+ 'TaskName' => ['title' => '任务名字', 'description' => '任务名字', 'type' => 'string', 'example' => '12344454'],
],
+ 'description' => '',
],
],
+ 'TotalSize' => ['title' => '总页数', 'description' => '总页数', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'Code' => ['description' => '干预服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '15',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '58',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"PubTime\\": \\"2024-01-22 10:29\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"Source\\": \\"新浪\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com/news/1.html\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 15,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 58\\n}","type":"json"}]',
- 'title' => '获取时效性视角列表',
- ],
- 'ListFreshViewPoints' => [
- 'summary' => '新颖视角列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '列出干预项导入任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"StatusList\\": [\\n {\\n \\"Msg\\": \\"Success\\",\\n \\"Percentage\\": 5,\\n \\"Status\\": 0,\\n \\"TaskId\\": \\"4854\\",\\n \\"TaskName\\": \\"12344454\\"\\n }\\n ],\\n \\"TotalSize\\": 0,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListInterveneRules' => [
+ 'summary' => '获得干预规则列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -22659,194 +15124,137 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'TopicSource',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源',
- 'description' => '热榜源',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜源',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
],
[
- 'name' => 'Topic',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜主题',
- ],
- ],
- [
- 'name' => 'NextToken',
+ 'name' => 'PageIndex',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '6',
- ],
+ 'schema' => ['title' => '页面尺寸', 'description' => '页面尺寸', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
- 'title' => 'PageResult2',
- 'description' => 'PageResult2',
+ 'title' => 'PlainResult<GetInterveneRuleListResult>',
+ 'description' => 'PlainResult<GetInterveneRuleListResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
+ 'type' => 'object',
+ 'properties' => [
+ 'Count' => ['title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'InterveneRuleList' => [
+ 'title' => '规则列表',
+ 'description' => '规则列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '规则描述',
+ 'type' => 'object',
+ 'properties' => [
+ 'AnswerConfig' => [
+ 'title' => '答案配置',
+ 'description' => '答案配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '答案配置项',
+ 'type' => 'object',
+ 'properties' => [
+ 'AnswerType' => [
+ 'title' => '答案类型',
+ 'description' => '答案类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => ['0-统一回复' => '0-统一回复', '1-定向回复 ' => '1-定向回复 '],
+ 'example' => '0',
+ ],
+ 'Message' => ['title' => '答案内容', 'description' => '答案内容', 'type' => 'string', 'example' => '抱歉我无法回答'],
+ 'Namespace' => ['title' => '命名空间', 'description' => '命名空间', 'type' => 'string', 'example' => 'namespace_qa_query'],
+ ],
],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
+ ],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-06-05 15:17:01'],
+ 'EffectTime' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2023-04-03 02:42:01'],
+ 'InterveneType' => [
+ 'title' => '干预类型',
+ 'description' => '干预类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'enumValueTitles' => ['0-永久生效' => '0-永久生效', '1-按时间生效' => '1-按时间生效'],
+ 'example' => '0',
+ ],
+ 'NamespaceList' => [
+ 'title' => '命名空间列表',
+ 'description' => '命名空间列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '干预范围',
'type' => 'string',
- 'example' => '大纲摘要',
+ 'enumValueTitles' => ['namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)', 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)', 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)', 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)'],
+ 'example' => 'namespace_qa_query',
],
],
+ 'RuleId' => ['title' => '规则id', 'description' => '规则id', 'type' => 'integer', 'format' => 'int64', 'example' => 'mr-iuo9pi9w555phfbb'],
+ 'RuleName' => ['title' => '规则名字', 'description' => '规则名字', 'type' => 'string', 'example' => 'ruletest'],
],
],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
],
+ 'PageIndex' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '页尺寸', 'description' => '页尺寸', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Code' => ['description' => '干预服务返回的状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '94',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '26',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '列出干预规则',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 94,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 26\\n}","type":"json"}]',
- 'title' => '获取新颖视角列表',
- ],
- 'ListWebReviewPoints' => [
- 'summary' => '网友视角列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListInterveneRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"Count\\": 1,\\n \\"InterveneRuleList\\": [\\n {\\n \\"AnswerConfig\\": [\\n {\\n \\"AnswerType\\": 0,\\n \\"Message\\": \\"抱歉我无法回答\\",\\n \\"Namespace\\": \\"namespace_qa_query\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-06-05 15:17:01\\",\\n \\"EffectTime\\": \\"2023-04-03 02:42:01\\",\\n \\"InterveneType\\": 0,\\n \\"NamespaceList\\": [\\n \\"namespace_qa_query\\"\\n ],\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"ruletest\\"\\n }\\n ],\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListIntervenes' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -22854,262 +15262,118 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'],
],
[
- 'name' => 'TopicSource',
+ 'name' => 'RuleId',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源',
- 'description' => '热榜源',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜源',
- ],
+ 'schema' => ['title' => '规则id', 'description' => '规则id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'mqtt_outRule_1679019634514'],
],
[
- 'name' => 'Topic',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜主题',
- ],
+ 'schema' => ['title' => '问题', 'description' => '问题', 'type' => 'string', 'required' => false, 'example' => '小猫'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'InterveneType',
'in' => 'formData',
'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
+ 'title' => '干预类型',
+ 'description' => '干预类型',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => '下一页的token',
+ 'enumValueTitles' => ['0-相似问干预项目' => '0-相似问干预项目', '2-正则表达式干预项 ' => '2-正则表达式干预项 ', ' 1-关键词表达式干预项 ' => ' 1-关键词表达式干预项 ', '3-关键词库干预项' => '3-关键词库干预项', ' 4-URL干预' => ' 4-URL干预'],
+ 'example' => '干预类型',
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'PageIndex',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '81',
- ],
+ 'schema' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '页面尺寸', 'description' => '页面尺寸', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PageResult2',
- 'description' => 'PageResult2',
+ 'title' => 'PlainResult<GetInterveneListResult>',
+ 'description' => 'PlainResult<GetInterveneListResult>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => '0'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'Comments' => [
- 'title' => '网友评论列表',
- 'description' => '网友观点列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '来源',
- ],
- 'Text' => [
- 'title' => '评论内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '内容',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'title' => '当前评论所属的URL',
- 'description' => '当前所属的URL',
- 'type' => 'string',
- 'example' => '当前所属的URL',
- ],
- 'Username' => [
- 'title' => '评论用户名',
- 'description' => '用户名',
- 'type' => 'string',
- 'example' => '用户名',
- ],
- ],
- ],
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
+ 'type' => 'object',
+ 'properties' => [
+ 'InterveneList' => [
+ 'title' => '干预项列表',
+ 'description' => '干预项列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => '36559'],
+ 'Query' => ['title' => '干预query', 'description' => '干预query', 'type' => 'string', 'example' => '伊家楼'],
],
+ 'description' => '',
],
],
+ 'PageIndex' => ['title' => '页号', 'description' => '页号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '页尺寸', 'description' => '页尺寸', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalSize' => ['title' => '总页书', 'description' => '总页书', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => ''],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '79',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '列出干预项',
+ 'summary' => '获得干预项列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T03:04:47.000Z', 'description' => '响应参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Comments\\": [\\n {\\n \\"Source\\": \\"来源\\",\\n \\"Text\\": \\"内容\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"当前所属的URL\\",\\n \\"Username\\": \\"用户名\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 79,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 32\\n}","type":"json"}]',
- 'title' => '获取网友视角列表',
- ],
- 'ListPlanningProposal' => [
- 'summary' => '获取选题策划列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListIntervenes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"InterveneList\\": [\\n {\\n \\"Id\\": \\"36559\\",\\n \\"Query\\": \\"伊家楼\\"\\n }\\n ],\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 1,\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListMaterialDocuments' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -23117,277 +15381,238 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'],
],
[
- 'name' => 'ViewPointType',
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['title' => '支持对 title、content、content的综合查询', 'description' => '支持对 title、content、content的综合查询', 'type' => 'string', 'required' => false, 'example' => '小猫'],
+ ],
+ [
+ 'name' => 'Id',
+ 'in' => 'formData',
+ 'schema' => ['title' => '素材主键ID', 'description' => '素材主键ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '69'],
+ ],
+ [
+ 'name' => 'Title',
+ 'in' => 'formData',
+ 'schema' => ['title' => '根据素材标题全文检索', 'description' => '根据素材标题全文检索', 'type' => 'string', 'required' => false, 'example' => '新闻标题'],
+ ],
+ [
+ 'name' => 'DocType',
'in' => 'formData',
'schema' => [
- 'title' => '选题策划类型。CustomViewPoints:自定义视角,HotViewPoints:热门视角、TimedViewPoints:时效性视角、WebReviewPoints:网友视角、FreshViewPoints:新颖视角',
- 'description' => '选题策划类型'."\n"
- ."\n"
- .'- CustomViewPoints:自定义视角'."\n"
- ."\n"
- .'- HotViewPoints:热门视角'."\n"
- ."\n"
- .'- TimedViewPoints:时效性视角'."\n"
- ."\n"
- .'- WebReviewPoints:网友视角'."\n"
- ."\n"
- .'- FreshViewPoints:新颖视角',
+ 'title' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
+ 'description' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
'type' => 'string',
- 'required' => true,
- 'example' => 'CustomViewPoints',
+ 'required' => false,
+ 'example' => 'jsonLine',
+ 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine', 'video', 'text'],
],
],
[
- 'name' => 'Titles',
+ 'name' => 'DocTypeList',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '选题策划标题筛选,对应各个选题策划类型的视角名称',
- 'description' => '选题策划标题筛选,对应各个选题策划类型的视角名称',
+ 'title' => '文档类型列表 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
+ 'description' => '文档类型列表 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
'type' => 'array',
'items' => [
- 'title' => '视角筛选',
- 'description' => '视角筛选',
+ 'description' => '文件类型对象。',
'type' => 'string',
'required' => false,
- 'example' => '标题'."\n"
- .' * ',
+ 'example' => 'html',
+ 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine'],
],
'required' => false,
- 'example' => '标题'."\n"
- .' * ',
+ 'example' => 'excel',
],
],
[
- 'name' => 'CustomViewPointId',
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文档内容全文检索', 'description' => '文档内容全文检索', 'type' => 'string', 'required' => false, 'example' => '新闻内容'],
+ ],
+ [
+ 'name' => 'ShareAttr',
'in' => 'formData',
'schema' => [
- 'title' => '自定义视角ID(用于自定义视角选题策划场景)',
- 'description' => '自定义视角ID(用于自定义视角选题策划场景)',
- 'type' => 'string',
+ 'title' => '共享属性:0:个人私有,1:业务空间范围内共享',
+ 'description' => '共享属性:0:个人私有,1:业务空间范围内共享',
+ 'type' => 'integer',
+ 'format' => 'int32',
'required' => false,
- 'example' => 'e7b26a9e1211444db8f0a984361a5e0f',
+ 'example' => '1',
+ 'enum' => ['0', '1'],
],
],
[
- 'name' => 'CustomViewPointIds',
+ 'name' => 'Keywords',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '自定义视角ID列表(用于自定义视角选题策划场景)',
- 'description' => '自定义视角ID列表(用于自定义视角选题策划场景)',
+ 'title' => '文档关键词',
+ 'description' => '文档关键词',
'type' => 'array',
- 'items' => [
- 'title' => '自定义视角ID(用于自定义视角选题策划场景)'."\n"
- .' * ',
- 'description' => '自定义视角ID(用于自定义视角选题策划场景)'."\n"
- .' * ',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3c67e87fc9044a8aae534f617195ab31',
- ],
+ 'items' => ['description' => '关键词', 'type' => 'string', 'required' => false, 'example' => '关键词'],
'required' => false,
- 'example' => '27971fc8f3ce4ed58c7e7fc4b503e432',
],
],
[
- 'name' => 'TopicSource',
+ 'name' => 'CreateTimeStart',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源',
- 'description' => '热榜源',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜源',
- ],
+ 'schema' => ['title' => '创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss', 'description' => '创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11'],
],
[
- 'name' => 'Topic',
+ 'name' => 'CreateTimeEnd',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜主题',
- ],
+ 'schema' => ['title' => '创建时间-结束范围,格式:yyyy-MM-dd HH:mm:ss', 'description' => '创建时间-结束范围,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'],
],
[
- 'name' => 'TopicVersion',
+ 'name' => 'UpdateTimeStart',
'in' => 'formData',
- 'schema' => [
- 'description' => '热点事件数据版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-09-10_08',
- ],
+ 'schema' => ['title' => '更新时间-开始范围,格式:yyyy-MM-dd HH:mm:ss', 'description' => '更新时间-开始范围,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'."\n"],
],
[
- 'name' => 'NextToken',
+ 'name' => 'UpdateTimeEnd',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的Token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的Token',
- ],
+ 'schema' => ['title' => '更新时间-结束范围,格式:yyyy-MM-dd HH:mm:ss', 'description' => '更新时间-结束范围,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 03:00:00'."\n"],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'GeneratePublicUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '73',
- ],
+ 'schema' => ['title' => '是否生成文件公共URL', 'description' => '是否生成文件公共URL', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Current',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'Size',
+ 'in' => 'formData',
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PageResult2',
- 'description' => 'PageResult2',
+ 'title' => '返回分页后的素材列表',
+ 'description' => '返回分页后的素材列表',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'description' => '列表对象',
'type' => 'array',
'items' => [
- 'description' => '选题策划对象',
+ 'description' => '素材对象',
'type' => 'object',
'properties' => [
- 'Outlines' => [
- 'description' => '大纲列表',
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'."\n"
+ ."\n"],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"],
+ 'CreateUser' => ['title' => '创建用户ID', 'description' => '创建用户ID', 'type' => 'string', 'example' => '"1"'],
+ 'CreateUserName' => ['title' => '创建用户姓名', 'description' => '创建用户姓名', 'type' => 'string', 'example' => '创建用户名'],
+ 'DocKeywords' => [
+ 'title' => '文档标签用于分类等、不同keyword之间逗号分割',
+ 'description' => '文档标签用于分类等、不同keyword之间逗号分割',
'type' => 'array',
- 'items' => [
- 'description' => '大纲对象',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
+ 'items' => ['description' => '关键词', 'type' => 'string', 'example' => '关键词'],
+ ],
+ 'DocType' => ['title' => '文档类型,pdf、word、url、image', 'description' => '文档类型,pdf、word、url、image', 'type' => 'string', 'example' => 'pdf'],
+ 'ExternalUrl' => ['title' => '外部客户上传的URL,仅用作记录保存', 'description' => '外部客户上传的URL,仅用作记录保存', 'type' => 'string', 'example' => 'https://www.example.com'."\n"],
+ 'HtmlContent' => ['description' => '网页内容', 'type' => 'string', 'example' => '网页内容'],
+ 'Id' => ['title' => '主键', 'description' => '主键', 'type' => 'integer', 'format' => 'int64', 'example' => '35'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"],
+ 'PublicUrl' => ['title' => '临时的对外公开的URL', 'description' => '临时的对外公开的URL', 'type' => 'string', 'example' => 'https://www.example.com'."\n"],
+ 'ShareAttr' => [
+ 'title' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
+ 'description' => '公开属性,按位存储,第一位表示是否在业务空间内共享、第二位表示是否在租户内共享,第三位表示在系统范围内共享',
+ 'type' => 'integer',
+ 'format' => 'int32',
+ 'example' => '1',
+ 'enum' => ['0', '1'],
+ ],
+ 'SrcFrom' => ['title' => '文档来源,user_upload、search、viewpoint', 'description' => '文档来源,user_upload、search、viewpoint', 'type' => 'string', 'example' => 'user_upload'],
+ 'Summary' => ['title' => '文档摘要', 'description' => '文档摘要', 'type' => 'string', 'example' => '摘要'],
+ 'TextContent' => ['title' => '解析后的文本内容,对于图片来说为空', 'description' => '解析后的文本内容,对于图片来说为空', 'type' => 'string', 'example' => '文档内容'],
+ 'ThumbnailInBase64' => ['title' => '图片文档类型的Base64缩略图', 'description' => '图片文档类型的Base64缩略图', 'type' => 'string', 'example' => 'base64编码的图像二进制数据'],
+ 'Title' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'example' => '文档标题'."\n"
+ ."\n"],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"],
+ 'UpdateUser' => ['title' => '修改用户ID', 'description' => '修改用户ID', 'type' => 'string', 'example' => '"1"'],
+ 'UpdateUserName' => ['title' => '修改用户姓名', 'description' => '修改用户姓名', 'type' => 'string', 'example' => '更新用户名'],
+ 'Url' => ['title' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除', 'description' => '内部文档保存的URL,支持多协议,http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除', 'type' => 'string', 'example' => 'https://www.example.com'],
+ 'FileKey' => ['description' => '文件唯一标识', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
+ 'FileAttr' => [
+ 'description' => '媒体文件属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'Duration' => ['description' => '时长。', 'type' => 'number', 'format' => 'double', 'example' => '120'],
+ 'FileName' => ['description' => '文件名', 'type' => 'string', 'example' => 'xxx.mp4'],
+ 'Width' => ['description' => '视频宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'MimeType' => ['description' => '文件MIME类型', 'type' => 'string', 'example' => 'image/png'],
+ 'FileLength' => ['description' => '文件内容长度', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576'],
+ 'Height' => ['description' => '视频高度', 'type' => 'integer', 'format' => 'int32', 'example' => '1024'],
],
],
- 'Summary' => [
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '77',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Size' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取素材列表',
+ 'summary' => '获取素材列表:获取素材库中素材列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-12T06:20:11.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-05-09T07:40:12.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 77,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 80\\n}","type":"json"}]',
- 'title' => '获取选题策划列表',
- ],
- 'ExportHotTopicPlanningProposals' => [
- 'summary' => '导出选题策划文档,响应为一个可公开访问的URL。一小时后失效。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListMaterialDocuments'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListMaterialDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Author\\": \\"作者\\\\n\\\\n\\",\\n \\"CreateTime\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"CreateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"CreateUserName\\": \\"创建用户名\\",\\n \\"DocKeywords\\": [\\n \\"关键词\\"\\n ],\\n \\"DocType\\": \\"pdf\\",\\n \\"ExternalUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"HtmlContent\\": \\"网页内容\\",\\n \\"Id\\": 35,\\n \\"PubTime\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"PublicUrl\\": \\"https://www.example.com\\\\n\\",\\n \\"ShareAttr\\": 1,\\n \\"SrcFrom\\": \\"user_upload\\",\\n \\"Summary\\": \\"摘要\\",\\n \\"TextContent\\": \\"文档内容\\",\\n \\"ThumbnailInBase64\\": \\"base64编码的图像二进制数据\\",\\n \\"Title\\": \\"文档标题\\\\n\\\\n\\",\\n \\"UpdateTime\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"UpdateUser\\": \\"\\\\\\"1\\\\\\"\\",\\n \\"UpdateUserName\\": \\"更新用户名\\",\\n \\"Url\\": \\"https://www.example.com\\",\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FileAttr\\": {\\n \\"Duration\\": 120,\\n \\"FileName\\": \\"xxx.mp4\\",\\n \\"Width\\": 100,\\n \\"MimeType\\": \\"image/png\\",\\n \\"FileLength\\": 1048576,\\n \\"Height\\": 1024\\n }\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Size\\": 10,\\n \\"Success\\": false,\\n \\"Total\\": 100\\n}","type":"json"}]',
+ ],
+ 'ListPlanningProposal' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -23395,288 +15620,268 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'ExportType',
+ 'name' => 'ViewPointType',
'in' => 'formData',
- 'schema' => [
- 'title' => '导出文档类型,word:导出为word,xmind:导处为xmind',
- 'description' => '导出文档类型'."\n"
- ."\n"
- .'- word:导出为word'."\n"
- ."\n"
- .'- xmind:导处为xmind',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'word',
- ],
+ 'schema' => ['title' => '选题策划类型。CustomViewPoints:自定义视角,HotViewPoints:热门视角、TimedViewPoints:时效性视角、WebReviewPoints:网友视角、FreshViewPoints:新颖视角', 'description' => '选题策划类型'."\n"
+ ."\n"
+ .'- CustomViewPoints:自定义视角'."\n"
+ ."\n"
+ .'- HotViewPoints:热门视角'."\n"
+ ."\n"
+ .'- TimedViewPoints:时效性视角'."\n"
+ ."\n"
+ .'- WebReviewPoints:网友视角'."\n"
+ ."\n"
+ .'- FreshViewPoints:新颖视角', 'type' => 'string', 'required' => true, 'example' => 'CustomViewPoints'],
],
[
'name' => 'Titles',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '根据选题策划的标题过滤',
- 'description' => '根据选题策划的标题过滤',
+ 'title' => '选题策划标题筛选,对应各个选题策划类型的视角名称',
+ 'description' => '选题策划标题筛选,对应各个选题策划类型的视角名称',
'type' => 'array',
- 'items' => [
- 'title' => '',
- 'description' => '选题策划标题过滤',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'items' => ['title' => '视角筛选', 'description' => '视角筛选', 'type' => 'string', 'required' => false, 'example' => '标题'."\n"
+ .' * '],
'required' => false,
+ 'example' => '标题'."\n"
+ .' * ',
],
],
[
- 'name' => 'ViewPointType',
+ 'name' => 'CustomViewPointId',
'in' => 'formData',
- 'schema' => [
- 'title' => '选题策划类型:CustomViewPoints:自定义视角,HotViewPoints:热门视角、TimedViewPoints:时效性视角、WebReviewPoints:网友视角、FreshViewPoints:新颖视角',
- 'description' => '选题策划类型'."\n"
- ."\n"
- .'- CustomViewPoints:自定义视角'."\n"
- ."\n"
- .'- HotViewPoints:热门视角'."\n"
- ."\n"
- .'- TimedViewPoints:时效性视角'."\n"
- ."\n"
- .'- WebReviewPoints:网友视角'."\n"
- ."\n"
- .'- FreshViewPoints:新颖视角',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CustomViewPoints',
- ],
+ 'schema' => ['title' => '自定义视角ID(用于自定义视角选题策划场景)', 'description' => '自定义视角ID(用于自定义视角选题策划场景)', 'type' => 'string', 'required' => false, 'example' => 'e7b26a9e1211444db8f0a984361a5e0f'],
],
[
'name' => 'CustomViewPointIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '自定义视角ID(用于自定义视角选题策划场景)',
- 'description' => '自定义视角ID(用于自定义视角选题策划场景)',
+ 'title' => '自定义视角ID列表(用于自定义视角选题策划场景)',
+ 'description' => '自定义视角ID列表(用于自定义视角选题策划场景)',
'type' => 'array',
- 'items' => [
- 'title' => '自定义视角ID(用于自定义视角选题策划场景)',
- 'description' => '自定义视角ID(用于自定义视角选题策划场景)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7d9139c4fd884be3b5db584c28501813',
- ],
+ 'items' => ['title' => '自定义视角ID(用于自定义视角选题策划场景)'."\n"
+ .' * ', 'description' => '自定义视角ID(用于自定义视角选题策划场景)'."\n"
+ .' * ', 'type' => 'string', 'required' => false, 'example' => '3c67e87fc9044a8aae534f617195ab31'],
'required' => false,
- 'example' => '025c6cee437741368098b790c90166f8',
+ 'example' => '27971fc8f3ce4ed58c7e7fc4b503e432',
],
],
[
'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜源',
- 'description' => '热榜源',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜源',
- ],
+ 'schema' => ['title' => '热榜源', 'description' => '热榜源', 'type' => 'string', 'required' => true, 'example' => '热榜源'],
],
[
'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '热榜主题',
- ],
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => true, 'example' => '热榜主题'],
+ ],
+ [
+ 'name' => 'TopicVersion',
+ 'in' => 'formData',
+ 'schema' => ['description' => '热点事件数据版本', 'type' => 'string', 'required' => false, 'example' => '2024-09-10_08'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的Token', 'type' => 'string', 'required' => false, 'example' => '下一页的Token'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '73'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '',
- 'description' => '',
+ 'title' => 'PageResult2',
+ 'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '可公开访问的URL。一小时后失效',
- 'description' => '可公开访问的URL。一小时后失效',
- 'type' => 'string',
- 'example' => '业务数据',
- ],
- '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',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '选题策划对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'description' => '大纲列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '大纲对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ ],
+ ],
+ 'Summary' => ['description' => '摘要', 'type' => 'string', 'example' => '摘要'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '标题'],
+ ],
+ ],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '77'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '80'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取选题策划列表',
+ 'summary' => '获取选题策划列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"业务数据\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '导出选题策划文档',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListPlanningProposal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 77,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 80\\n}","type":"json"}]',
],
- 'DeleteCustomTopicByTopic' => [
- 'summary' => '根据热点名称删除自定义热点事件。',
+ 'ListPptArtifacts' => [
+ 'summary' => '查询PPT作品列表',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-az2xxxx'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['description' => '搜索关键词:作品名称', 'type' => 'string', 'required' => false, 'example' => '数字时代的营销策划与文案创作'],
+ ],
+ [
+ 'name' => 'MaxResults',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['description' => '本次请求期望查询的数据条目(废弃)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'],
],
[
- 'name' => 'Topic',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义主题',
- 'description' => '自定义主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '话题',
- ],
+ 'schema' => ['title' => '第三方传入的用户ID', 'type' => 'string', 'example' => 'abc'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Current' => ['description' => '当前页。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '33',
- ],
- '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',
+ 'description' => '是否删除成功',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'CreateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2024-01-04 11:46:07'],
+ 'Id' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '作品标题'],
+ 'UpdateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2025-04-14 19:59:53'],
+ 'FileKey' => ['description' => '作品文件预览图', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jpg'],
+ 'FileAttr' => [
+ 'description' => '作品文件属性',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileName' => ['description' => '文件名', 'type' => 'string', 'example' => '数字时代的营销策划与文案创作'],
+ 'Width' => ['description' => '视频宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'TmpUrl' => ['description' => '作品文件预览图', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jpg'],
+ 'Height' => ['description' => '高度', 'type' => 'integer', 'format' => 'int32', 'example' => '500'],
+ ],
+ ],
+ ],
+ ],
],
+ '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'],
+ 'Size' => ['description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NextToken' => ['description' => '下一页的Token', 'type' => 'string', 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='."\n"],
+ 'MaxResults' => ['description' => '本次返回的数据条目', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询PPT作品列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": 33,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除自定义热点事件',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListPptArtifacts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"Id\\": 10,\\n \\"Title\\": \\"作品标题\\",\\n \\"UpdateTime\\": \\"2025-04-14 19:59:53\\",\\n \\"FileKey\\": \\"http://www.example.com/xxx.jpg\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"数字时代的营销策划与文案创作\\",\\n \\"Width\\": 100,\\n \\"TmpUrl\\": \\"http://www.example.com/xxx.jpg\\",\\n \\"Height\\": 500\\n }\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100,\\n \\"NextToken\\": \\"cEoBWREAXdxaOyjq/cqAbg==\\\\n\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
],
- 'ListTopicViewPointRecommendEventList' => [
- 'summary' => '获取热点事件推荐观点列表。',
+ 'ListPptTemplates' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -23684,148 +15889,105 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['description' => '下一页的Token', 'type' => 'string', 'required' => false, 'example' => '+CBOXvu2YLxC6DOua8Qupg=='],
],
[
'name' => 'MaxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '暂不支持修改,固定为10'],
+ ],
+ [
+ 'name' => 'SceneId',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数。默认5条',
- 'description' => '最大返回结果数。默认5条',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '66',
- ],
+ 'schema' => ['title' => '模板场景ID', 'description' => '模板场景ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'],
],
[
- 'name' => 'Id',
+ 'name' => 'StyleId',
'in' => 'formData',
- 'schema' => [
- 'description' => '热点事件ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '风格id', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'ColourId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '颜色ID', 'description' => '颜色ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'CareerId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '职业ID', 'description' => '职业ID', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PageResult2',
- 'description' => 'PageResult2',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'Data' => [
- 'title' => '业务数据',
'description' => '业务数据',
'type' => 'array',
'items' => [
- 'description' => '热门观点列表',
- 'type' => 'string',
- 'example' => 'xxxx',
+ 'description' => '模板数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'],
+ 'CoverImg' => ['title' => '封面图', 'description' => '封面图', 'type' => 'string', 'example' => 'http://xxx.com/a.png'],
+ ],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '8',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '32',
- ],
+ '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'],
+ 'Size' => ['description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NextToken' => ['description' => '下一页的Token', 'type' => 'string', 'example' => '+CBOXvu2YLxC6DOua8Qupg=='],
+ 'MaxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询PPT模板列表',
+ 'summary' => '查询PPT模板列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n \\"xxxx\\"\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 8,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 32\\n}","type":"json"}]',
- 'title' => '获取热点事件推荐观点列表',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListPptTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Id\\": 10,\\n \\"CoverImg\\": \\"http://xxx.com/a.png\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100,\\n \\"NextToken\\": \\"+CBOXvu2YLxC6DOua8Qupg==\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
],
- 'ListTopicRecommendEventList' => [
- 'summary' => '获取热点推荐事件。',
+ 'ListSearchTaskDialogueDatas' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -23833,821 +15995,532 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['title' => '查询条件', 'description' => '查询条件', 'type' => 'string', 'required' => false, 'example' => 'xx'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '72',
- ],
+ 'schema' => ['title' => '任务id', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'OriginalSessionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '历史对话唯一标识:全量原始素材来源', 'description' => '历史对话唯一标识:全量原始素材来源', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '历史对话唯一标识:参考素材来源', 'description' => '历史对话唯一标识:参考素材来源', 'type' => 'string', 'required' => true, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'MultimodalSearchType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '搜索数据类型', 'description' => '搜索数据类型', 'type' => 'string', 'required' => false, 'example' => 'text'],
+ ],
+ [
+ 'name' => 'SearchModel',
+ 'in' => 'formData',
+ 'schema' => ['title' => '搜索agent类型', 'description' => '搜索agent类型', 'type' => 'string', 'required' => false, 'example' => 'ClusterGenerate'],
+ ],
+ [
+ 'name' => 'SearchModelDataValue',
+ 'in' => 'formData',
+ 'schema' => ['title' => '搜索agent分类下的数据', 'description' => '搜索agent分类下的数据', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'IncludeContent',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否包含正文', 'description' => '是否包含正文', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'PageNumber',
+ 'in' => 'formData',
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'],
+ ],
+ [
+ 'name' => 'PageSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '10'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PageResult2',
- 'description' => 'PageResult2',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Data' => [
- 'description' => '热点事件列表',
+ 'RealtimeSearch' => ['title' => '是否实时搜索', 'description' => '是否实时搜索', 'type' => 'boolean', 'example' => 'true'],
+ 'SearchType' => ['title' => '搜索类型', 'description' => '搜索类型', 'type' => 'string', 'example' => 'realtime'],
+ 'Articles' => [
+ 'title' => '文章列表',
+ 'description' => '文章列表',
'type' => 'array',
'items' => [
- 'description' => '热点事件',
- 'type' => 'string',
- 'example' => '热点事件',
+ 'description' => '文章',
+ 'type' => 'object',
+ 'properties' => [
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-11-25 14:25:59'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '新华社'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xxx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '文档-自定义的唯一ID'],
+ 'MultimodalMedias' => [
+ 'description' => '多模态信息',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '多模态信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => '多模态数据唯一标识'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据类型', 'type' => 'string', 'example' => '多模态数据类型'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '图片或视频文件地址', 'type' => 'string', 'example' => '图片或视频文件地址'],
+ ],
+ ],
+ ],
+ 'DocType' => ['title' => '文档类型', 'description' => '文档类型', 'type' => 'string', 'example' => 'text'],
+ 'CategoryUuid' => ['title' => '类目唯一标识', 'description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['title' => '扩展字段1', 'description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['title' => '扩展字段2', 'description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['title' => '扩展字段3', 'description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
+ ],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'description' => '返回的最大记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '71',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'description' => '下一页Token',
- 'type' => 'string',
- 'example' => 'x\'x\'x',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
+ 'Images' => [
+ 'title' => '图片列表',
+ 'description' => '图片列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '图片对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => '多模态数据唯一标识'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据类型', 'type' => 'string', 'example' => '多模态数据类型'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '图片或视频文件地址', 'type' => 'string', 'example' => '图片或视频文件地址'],
+ ],
+ ],
],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Videos' => [
+ 'title' => '视频列表',
+ 'description' => '视频列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '视频信息列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => '多模态数据唯一标识'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据类型', 'type' => 'string', 'example' => '多模态数据类型'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '图片或视频文件地址', 'type' => 'string', 'example' => '图片或视频文件地址'],
+ ],
+ ],
],
- 'TotalCount' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页记录条数', 'description' => '每页记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '总记录条数', 'description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Audios' => [
+ 'title' => '语音列表',
+ 'description' => '语音列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '语音信息',
+ 'description' => '语音信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xxxx'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '图片或视频文件地址', 'type' => 'string', 'example' => 'http://xxx'],
+ ],
+ ],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询搜索生成任务对话详情中数据列表',
+ 'summary' => '查询搜索生成任务对话详情中数据列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-09-29T12:05:41.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n \\"热点事件\\"\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 71,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"x\'x\'x\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 60\\n}","type":"json"}]',
- 'title' => '获取热点推荐事件列表',
- ],
- 'RunCustomHotTopicAnalysis' => [
- 'summary' => '自定义热点话题分析。',
- 'path' => '/quanmiao/miaoce/runCustomHotTopicAnalysis',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListSearchTaskDialogueDatas',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RealtimeSearch\\": true,\\n \\"SearchType\\": \\"realtime\\",\\n \\"Articles\\": [\\n {\\n \\"PubTime\\": \\"2024-11-25 14:25:59\\",\\n \\"Source\\": \\"新华社\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"Author\\": \\"作者\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"DocUuid\\": \\"xxx\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"DocType\\": \\"text\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"Images\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"Videos\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Audios\\": [\\n {\\n \\"MediaId\\": \\"xxxx\\",\\n \\"FileUrl\\": \\"http://xxx\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ListSearchTaskDialogues' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'AskUser',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '模型反问',
- 'description' => '模型反问',
- 'type' => 'string',
- 'required' => false,
- 'example' => '模型反问',
- ],
- ],
- [
- 'name' => 'UserBack',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '用户针对模型反问的输入',
- 'description' => '用户针对模型反问的输入',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户针对模型反问的输入',
- ],
- ],
- [
- 'name' => 'Prompt',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户输入Prompt',
- 'description' => '用户输入Prompt',
- 'type' => 'string',
- 'required' => true,
- 'example' => '用户输入Prompt',
- ],
+ 'schema' => ['title' => '返回结果数量', 'description' => '返回结果数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'ForceAnalysisExistsTopic',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '针对重复的话题,是否强制分析并覆盖已有的话题分析',
- 'description' => '针对重复的话题,是否强制分析并覆盖已有的话题分析',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['title' => '任务唯一标识', 'description' => '任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '每次请求唯一标识',
- 'description' => '每次请求唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '整轮对话任务ID',
- 'description' => '整轮对话任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'CustomHoTTopicBaseLlmResponse',
- 'description' => 'CustomHoTTopicBaseLlmResponse',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Articles' => [
- 'title' => '参照文章',
- 'description' => '参照文章',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章对象',
+ 'Data' => [
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'SessionId' => ['title' => '单轮对话唯一标识', 'description' => '单轮对话唯一标识', 'type' => 'string', 'example' => 'xxxx'],
+ 'OriginSessionId' => ['title' => '原始的SessionId', 'description' => '原始的SessionId', 'type' => 'string', 'example' => 'xxxx'],
+ 'TaskId' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'example' => 'xxxx'],
+ 'Rating' => ['title' => '点赞点踩', 'description' => '点赞点踩', 'type' => 'string', 'example' => 'thumbsUp'],
+ 'Tags' => [
+ 'title' => '标签',
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => ['description' => '标签信息', 'type' => 'string', 'example' => 'xx'],
+ ],
+ 'Text' => ['title' => '客户反馈意见', 'description' => '客户反馈意见', 'type' => 'string', 'example' => 'xxx'],
+ 'GoodText' => ['title' => '客户认为好的生成内容', 'description' => '客户认为好的生成内容', 'type' => 'string', 'example' => 'xxx'],
+ 'Prompt' => ['title' => '输入', 'description' => '输入', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2024-11-25 13:33:01'],
+ 'DialogueType' => ['title' => '生成类型', 'description' => '生成类型', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'ResponseBodyStr' => ['title' => '响应结果字符串', 'description' => '响应结果字符串', 'type' => 'string', 'example' => '{}'],
+ 'ChatConfig' => [
+ 'title' => '配置',
+ 'description' => '配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'GenerateTechnology' => ['title' => '生成类型', 'description' => '生成类型', 'type' => 'string', 'example' => 'copilotReference'],
+ 'SearchParam' => [
'type' => 'object',
'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '文档-自定义的唯一ID',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'a2103fcfbd5441f1991c72f8834833e3',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-08-27 14:50:47',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Tag' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'string',
- 'example' => '文章标签',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
+ 'SearchSources' => [
+ 'title' => '搜索源',
+ 'description' => '搜索源',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '搜索源',
+ 'description' => '搜索源',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'example' => 'x\'x'],
+ 'Name' => ['title' => '描述', 'description' => '描述', 'type' => 'string', 'example' => 'x'],
+ 'DatasetName' => ['title' => '唯一标识', 'description' => '唯一标识', 'type' => 'string', 'example' => 'xx'],
+ ],
+ ],
],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
+ 'EndTime' => ['type' => 'string', 'description' => ''],
+ 'StartTime' => ['type' => 'string', 'description' => ''],
+ 'MultimodalSearchTypes' => [
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => ''],
+ 'description' => '',
],
],
+ 'description' => '',
],
- ],
- 'AskUser' => [
- 'title' => '反问列表',
- 'description' => '反问列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '模型反问',
- 'type' => 'string',
- 'example' => 'xxx',
+ 'DialogueType' => ['title' => '请求类型', 'description' => '请求类型', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'GenerateLevel' => ['title' => '生成级别', 'description' => '生成级别', 'type' => 'string', 'example' => 'concise'],
+ 'EndToEnd' => ['title' => '是否端到端', 'description' => '是否端到端', 'type' => 'boolean'],
+ 'SearchModels' => [
+ 'title' => '搜索类型',
+ 'description' => '搜索类型',
+ 'type' => 'array',
+ 'items' => ['title' => '搜索类型', 'description' => '搜索类型', 'type' => 'string', 'example' => 'TextGenerate'],
],
],
- 'AsyncTaskId' => [
- 'title' => '异步任务ID',
- 'description' => '异步任务ID',
- 'type' => 'string',
- 'example' => '异步任务ID',
- ],
- 'Attitude' => [
- 'title' => '自定义选题视角',
- 'description' => '自定义选题视角',
- 'type' => 'string',
- 'example' => '自定义选题视角',
- ],
- 'SearchQuery' => [
- 'title' => 'query改写结果',
- 'description' => 'query改写结果',
- 'type' => 'string',
- 'example' => '大模型改变世界',
- ],
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- 'TopicId' => [
- 'title' => '话题ID',
- 'description' => '话题ID',
- 'type' => 'string',
- 'example' => '话题ID',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token使用量',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '60',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '13',
- ],
- 'TotalTokens' => [
- 'description' => '总token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '73',
- ],
],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页记录条数', 'description' => '每页记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '总记录条数', 'description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询妙搜搜索生成任务详情列表',
+ 'summary' => '查询妙搜搜索生成任务详情列表。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-08T04:13:51.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListSearchTaskDialogues',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"a2103fcfbd5441f1991c72f8834833e3\\",\\n \\"PubTime\\": \\"2024-08-27 14:50:47\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"AskUser\\": [\\n \\"xxx\\"\\n ],\\n \\"AsyncTaskId\\": \\"异步任务ID\\",\\n \\"Attitude\\": \\"自定义选题视角\\",\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\",\\n \\"TopicId\\": \\"话题ID\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 60,\\n \\"OutputTokens\\": 13,\\n \\"TotalTokens\\": 73\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
- 'title' => '自定义热点话题分析',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"xxxx\\",\\n \\"OriginSessionId\\": \\"xxxx\\",\\n \\"TaskId\\": \\"xxxx\\",\\n \\"Rating\\": \\"thumbsUp\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Text\\": \\"xxx\\",\\n \\"GoodText\\": \\"xxx\\",\\n \\"Prompt\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-25 13:33:01\\",\\n \\"DialogueType\\": 24,\\n \\"ResponseBodyStr\\": \\"{}\\",\\n \\"ChatConfig\\": {\\n \\"GenerateTechnology\\": \\"copilotReference\\",\\n \\"SearchParam\\": {\\n \\"SearchSources\\": [\\n {\\n \\"Code\\": \\"x\'x\\",\\n \\"Name\\": \\"x\\",\\n \\"DatasetName\\": \\"xx\\"\\n }\\n ],\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"MultimodalSearchTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"DialogueType\\": 24,\\n \\"GenerateLevel\\": \\"concise\\",\\n \\"EndToEnd\\": true,\\n \\"SearchModels\\": [\\n \\"TextGenerate\\"\\n ]\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'RunCustomHotTopicViewPointAnalysis' => [
- 'summary' => '自定义选题视角分析。',
- 'path' => '/quanmiao/miaoce/runCustomHotTopicViewPointAnalysis',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'ListSearchTasks' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'AskUser',
+ 'name' => 'DialogueTypes',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '模型反问',
- 'description' => '模型反问',
- 'type' => 'string',
+ 'title' => '任务类型',
+ 'description' => '任务类型',
+ 'type' => 'array',
+ 'items' => ['description' => '任务类型', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '24'],
'required' => false,
- 'example' => '模型反问',
+ 'example' => '24',
],
],
[
- 'name' => 'UserBack',
+ 'name' => 'PageNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户反馈',
- 'description' => '用户反馈',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户反馈',
- ],
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '1'],
],
[
- 'name' => 'SearchQuery',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'title' => '改写后的Query',
- 'description' => '改写后的Query',
- 'type' => 'string',
- 'required' => false,
- 'example' => '改写后的Query',
- ],
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '10'],
],
- [
- 'name' => 'Prompt',
- 'in' => 'formData',
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '自定义选题视角的Prompt',
- 'description' => '自定义选题视角的Prompt',
- 'type' => 'string',
- 'required' => true,
- 'example' => '自定义选题视角的Prompt',
+ 'title' => '响应结果',
+ 'description' => '响应结果',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务唯一标识', 'description' => '任务唯一标识', 'type' => 'string', 'example' => 'xxxx'],
+ 'TaskName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-25 11:40:50'],
+ 'UpdateTime' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-11-25 11:40:50'],
+ 'DialogueType' => ['title' => '任务类型', 'description' => '任务类型', 'type' => 'integer', 'format' => 'int32', 'example' => '24'],
+ 'Username' => ['title' => '创建人名称', 'description' => '创建人名称', 'type' => 'string', 'example' => 'xxxx'],
+ ],
+ ],
+ ],
+ 'PageNumber' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'PageSize' => ['title' => '每页记录条数', 'description' => '每页记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'TotalCount' => ['title' => '总记录条数', 'description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询妙搜搜索生成历史任务列表',
+ 'summary' => '查询妙搜搜索生成历史任务列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SkipAskUser',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否跳过反问',
- 'description' => '是否跳过反问',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListSearchTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"xxxx\\",\\n \\"TaskName\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"UpdateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"DialogueType\\": 24,\\n \\"Username\\": \\"xxxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
+ ],
+ 'ListStyleLearningResult' => [
+ 'summary' => '获取文体学习分析结果列表。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'TopicId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热点主题ID',
- 'description' => '热点主题ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热点主题ID',
- ],
+ 'AK' => [],
],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'Topic',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热点主题',
- 'description' => '热点主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热点主题',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'TopicVersion',
+ 'name' => 'Current',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点主题版本',
- 'description' => '热点主题版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热点主题版本',
- ],
+ 'schema' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'TopicSource',
+ 'name' => 'Size',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点主题来源',
- 'description' => '热点主题来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热点主题来源',
- ],
+ 'schema' => ['title' => '每页条数:默认10', 'description' => '每页条数:默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
- 'title' => 'CustomHoTTopicBaseLlmResponse',
- 'description' => 'CustomHoTTopicBaseLlmResponse',
+ 'title' => 'PageResult',
+ 'description' => 'PageResult',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'title' => '响应头',
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'OriginSessionId' => [
- 'title' => '父会话ID',
- 'description' => '父会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '全链路ID',
- ],
- ],
- ],
- 'Payload' => [
- 'title' => '响应体',
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'title' => '输出',
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'AskUser' => [
- 'title' => '反问列表',
- 'description' => '反问列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '模型反问',
- 'type' => 'string',
- 'example' => 'xxxxxxx',
- ],
- ],
- 'AsyncTaskId' => [
- 'title' => '异步任务ID',
- 'description' => '异步任务ID',
- 'type' => 'string',
- 'example' => '异步任务ID',
- ],
- 'Attitude' => [
- 'title' => '模型生成的自定义选题视角的观点',
- 'description' => '模型生成的自定义选题视角的观点',
- 'type' => 'string',
- 'example' => '模型生成的自定义选题视角的观点',
- ],
- 'CustomViewPointId' => [
- 'description' => '自定义视角ID',
- 'type' => 'string',
- 'example' => 'xxxxxx',
- ],
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- 'TopicId' => [
- 'title' => '话题ID',
- 'description' => '话题ID',
- 'type' => 'string',
- 'example' => '话题ID',
- ],
- 'Articles' => [
- 'title' => '参考文章列表',
- 'description' => '参考文章列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '参考文章对象',
- 'description' => '参考文章对象',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者'."\n"
- ."\n",
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-09-10 14:17:53',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Url' => [
- 'title' => 'URL标题',
- 'description' => 'URL标题',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Usage' => [
- 'description' => '镜像是否已经运行在ECS实例中。取值范围:'."\n"
- ."\n"
- .'- instance:镜像处于运行状态,有ECS实例使用。'."\n"
- .'- none:镜像处于闲置状态,暂无ECS实例使用。',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '51',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '79',
- ],
- 'TotalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '130',
- ],
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Current' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'description' => '文体学习分析结果集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'AigcResult' => ['title' => 'AIGC 生成的内容', 'description' => 'AIGC 生成的内容', 'type' => 'string', 'example' => 'AIGC 生成的内容'],
+ 'Id' => ['title' => '文体学习分析结果ID', 'description' => '文体学习分析结果ID', 'type' => 'integer', 'format' => 'int64', 'example' => '70'],
+ 'RewriteResult' => ['title' => '用户修订后内容', 'description' => '用户修订后内容', 'type' => 'string', 'example' => '用户修订后内容'],
+ 'StyleName' => ['title' => '文体风格名称', 'description' => '文体风格名称', 'type' => 'string', 'example' => '文体风格名称'],
+ 'TaskId' => ['title' => '文体分析时的任务ID', 'description' => '文体分析时的任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
],
- 'RequestId' => [
- 'title' => '请求ID',
- 'description' => '请求ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ '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'],
+ 'Size' => ['title' => '每页记录条数', 'description' => '每页记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['title' => '总记录条数', 'description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取文体学习分析结果列表',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"AskUser\\": [\\n \\"xxxxxxx\\"\\n ],\\n \\"AsyncTaskId\\": \\"异步任务ID\\",\\n \\"Attitude\\": \\"模型生成的自定义选题视角的观点\\",\\n \\"CustomViewPointId\\": \\"xxxxxx\\",\\n \\"Text\\": \\"文本生成结果\\",\\n \\"TopicId\\": \\"话题ID\\",\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\\\n\\\\n\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"PubTime\\": \\"2024-09-10 14:17:53\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\",\\n \\"Summary\\": \\"文章摘要\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 51,\\n \\"OutputTokens\\": 79,\\n \\"TotalTokens\\": 130\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
- 'title' => '自定义选题视角分析',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"AigcResult\\": \\"AIGC 生成的内容\\",\\n \\"Id\\": 70,\\n \\"RewriteResult\\": \\"用户修订后内容\\",\\n \\"StyleName\\": \\"文体风格名称\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
],
- 'ListCustomViewPoints' => [
- 'summary' => '自定义视角列表。',
+ 'ListTimedViewAttitude' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -24655,217 +16528,63 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'Topic',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '热榜主题',
- 'description' => '热榜主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热榜主题',
- ],
- ],
- [
- 'name' => 'Attitude',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '筛选对应观点',
- 'description' => '筛选对应观点',
- 'type' => 'string',
- 'required' => false,
- 'example' => '观点',
- ],
- ],
- [
- 'name' => 'Attitudes',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '筛选观点列表',
- 'description' => '筛选观点列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '观点',
- 'description' => '观点',
- 'type' => 'string',
- 'required' => false,
- 'example' => '观点'."\n"
- .' * ',
- ],
- 'required' => false,
- 'example' => '观点'."\n"
- .' * ',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'CustomViewPointId',
+ 'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义视角ID',
- 'description' => '自定义视角ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '461591f4880747f890702c1b90494d1a',
- ],
+ 'schema' => ['title' => '热榜源', 'description' => '热榜源', 'type' => 'string', 'required' => true, 'example' => '热榜源'],
],
[
- 'name' => 'CustomViewPointIds',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '自定义视角ID列表',
- 'description' => '自定义视角ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '自定义视角ID',
- 'description' => '自定义视角ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'bb1a5426a9c34e3e8165e7939032bddd',
- ],
- 'required' => false,
- 'example' => '7ece3d1212e04c9ca716ae2486228f3f',
- ],
- ],
- [
- 'name' => 'TopicId',
+ 'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '话题ID',
- 'description' => '话题ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1d20ed14db0840efb1c7eaaf4d46352b',
- ],
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => true, 'example' => '热榜主题'],
],
[
'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '下一页的token',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的Token', 'type' => 'string', 'required' => false, 'example' => '下一页的Token'],
],
[
'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '52',
- ],
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '53'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'PageResult2',
'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'array',
'items' => [
+ 'description' => '时效性观点对象',
'type' => 'object',
'properties' => [
- 'AsyncTaskId' => [
- 'title' => '异步任务ID(分析该自定义视角的任务)',
- 'description' => '异步任务ID(分析该自定义视角的任务)',
- 'type' => 'string',
- 'example' => '2323ac73e174428a98c91097a59c67e0',
- ],
- 'Attitude' => [
- 'title' => '观点',
- 'description' => '观点',
- 'type' => 'string',
- 'example' => '观点',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-08-15 16:18:59',
- ],
- 'CreateUser' => [
- 'title' => '创建用户ID',
- 'description' => '创建用户ID',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Id' => [
- 'title' => '自定义视角ID',
- 'description' => '自定义视角ID',
- 'type' => 'string',
- 'example' => '709806dd051042d5ab9de8bdbb3a64ca',
- ],
- 'Status' => [
- 'title' => '任务执行状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'description' => '任务执行状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'type' => 'string',
- 'example' => 'RUNNING',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
- ],
- ],
- 'TaskErrorMessage' => [
- 'title' => '任务执行错误信息',
- 'description' => '任务执行错误信息',
- 'type' => 'string',
- 'example' => '参数校验失败',
- ],
- 'TaskStatus' => [
- 'title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-01-22 10:29'],
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'Source' => ['title' => '新闻来源', 'description' => '新闻来源', 'type' => 'string', 'example' => '新浪'],
+ 'Title' => ['title' => '当前观点 等价于 新闻标题', 'description' => '当前观点,等价于新闻标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['title' => '新闻URL', 'description' => '新闻URL', 'type' => 'string', 'example' => 'http://www.example.com/news/1.html'],
'ViewPoints' => [
'title' => '选题视角列表',
'description' => '选题视角列表',
'type' => 'array',
'items' => [
+ 'description' => '视角对象',
'type' => 'object',
'properties' => [
'Outlines' => [
@@ -24873,388 +16592,313 @@
'description' => '大纲',
'type' => 'array',
'items' => [
+ 'description' => '大纲',
'type' => 'object',
'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
],
],
],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
],
],
],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'title' => '最大返回结果数',
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '60',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'NextToken' => [
- 'title' => '下一页的token',
- 'description' => '下一页的token',
- 'type' => 'string',
- 'example' => '下一页的token',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '73',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '58'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取时效性视角列表',
+ 'summary' => '时效性视角列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"AsyncTaskId\\": \\"2323ac73e174428a98c91097a59c67e0\\",\\n \\"Attitude\\": \\"观点\\",\\n \\"CreateTime\\": \\"2024-08-15 16:18:59\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"Id\\": \\"709806dd051042d5ab9de8bdbb3a64ca\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"TaskErrorMessage\\": \\"参数校验失败\\",\\n \\"TaskStatus\\": 1,\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 60,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 73\\n}","type":"json"}]',
- 'title' => '获取自定义视角列表',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListTimedViewAttitude',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"PubTime\\": \\"2024-01-22 10:29\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"Source\\": \\"新浪\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com/news/1.html\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 15,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 58\\n}","type":"json"}]',
],
- 'DeleteCustomTopicViewPointById' => [
- 'summary' => '根据自定义选题视角ID删除自定义选题视角。',
+ 'ListTopicRecommendEventList' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'CustomViewPointId',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义视角ID',
- 'description' => '自定义视角ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dfd73894e6a94fd79fe7ffbe865796fb',
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '72'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PageResult2',
+ 'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '7',
- ],
- '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',
+ 'description' => '热点事件列表',
+ 'type' => 'array',
+ 'items' => ['description' => '热点事件', 'type' => 'string', 'example' => '热点事件'],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['description' => '返回的最大记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '71'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['description' => '下一页Token', 'type' => 'string', 'example' => 'x\'x\'x'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '60'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取热点推荐事件列表',
+ 'summary' => '获取热点推荐事件。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": 7,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除自定义选题视角',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListTopicRecommendEventList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n \\"热点事件\\"\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 71,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"x\'x\'x\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 60\\n}","type":"json"}]',
],
- 'SubmitDocClusterTask' => [
- 'summary' => '提交内容聚合任务。',
+ 'ListTopicViewPointRecommendEventList' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'Documents',
+ 'name' => 'NextToken',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '文档列表',
- 'description' => '文档列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '文档内容',
- 'description' => '文档内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '文档内容',
- 'maxLength' => 3000,
- 'minLength' => 1,
- ],
- 'DocId' => [
- 'title' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错',
- 'description' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错',
- ],
- 'Title' => [
- 'title' => '文档标题',
- 'description' => '文档标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文档标题',
- 'maxLength' => 100,
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- 'maxItems' => 10000,
- 'minItems' => 2,
- ],
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
],
[
- 'name' => 'TopicCount',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'schema' => [
- 'title' => '最大聚合总数',
- 'description' => '最大聚合总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '100',
- 'example' => '15',
- ],
+ 'schema' => ['title' => '最大返回结果数。默认5条', 'description' => '最大返回结果数。默认5条', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '66'],
],
[
- 'name' => 'TitleLength',
+ 'name' => 'Id',
'in' => 'formData',
+ 'schema' => ['description' => '热点事件ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '生成聚类的标题字数限制',
- 'description' => '生成聚类的标题字数限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '200',
- 'example' => '69',
+ 'title' => 'PageResult2',
+ 'description' => 'PageResult2',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => ['description' => '热门观点列表', 'type' => 'string', 'example' => 'xxxx'],
+ ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '8'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
+ ],
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取热点事件推荐观点列表',
+ 'summary' => '获取热点事件推荐观点列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'SummaryLength',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '生成聚类的摘要字数限制',
- 'description' => '生成聚类的摘要字数限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'maximum' => '500',
- 'example' => '49',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListTopicViewPointRecommendEventList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n \\"xxxx\\"\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 8,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 32\\n}","type":"json"}]',
+ ],
+ 'ListVersions' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'],
+ ],
+ ],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'PlainResult',
'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '列表对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'ConcurrentCount' => ['title' => '并发数', 'description' => '并发数', 'type' => 'integer', 'format' => 'int32', 'example' => '43'],
+ 'EndTime' => ['title' => '服务到期时间', 'description' => '服务到期时间', 'type' => 'string', 'example' => '2023-04-23 02:00:34'],
+ 'InstanceCount' => ['title' => '实例数', 'description' => '实例数', 'type' => 'integer', 'format' => 'int32', 'example' => '55'],
+ 'InstanceId' => ['title' => '实例ID', 'description' => '实例ID', 'type' => 'string', 'example' => 'ga-bp12pismsw4v3tzhf62p1'],
+ 'OrderId' => ['title' => '订单ID', 'description' => '订单ID', 'type' => 'integer', 'format' => 'int64', 'example' => '7'],
+ 'ProductType' => [
+ 'title' => '版本类型 (TRIAL: 试用版, STANDARD: 专业版, CUSTOMIZE: 定制版)',
+ 'description' => '版本类型 (TRIAL: 试用版, STANDARD: 专业版, CUSTOMIZE: 定制版)',
+ 'type' => 'string',
+ 'example' => 'CUSTOMIZE',
+ 'enum' => ['TRIAL', 'STANDARD', 'CUSTOMIZE'],
+ ],
+ 'Quota' => ['title' => '试用版限额次数', 'description' => '试用版限额次数', 'type' => 'integer', 'format' => 'int32', 'example' => '13'],
+ 'StartTime' => ['title' => '服务开始时间', 'description' => '服务开始时间', 'type' => 'string', 'example' => '2023-05-27 04:11:00'],
+ 'UseQuota' => ['title' => '试用版已使用次数', 'description' => '试用版已使用次数', 'type' => 'integer', 'format' => 'int32', 'example' => '65'],
+ 'VersionDetail' => ['title' => '版本明细', 'description' => '版本明细', 'type' => 'string', 'example' => '标准版-公共并发:1并发'],
+ 'VersionName' => [
+ 'title' => '版本',
+ 'description' => '版本',
+ 'type' => 'string',
+ 'example' => '试用版',
+ 'enum' => ['试用版', '专业版', '定制版'],
+ ],
+ 'VersionStatus' => ['title' => '有效状态:0-表示有效、1-版本过期-续费页、2-版本不可用-购买页', 'description' => '有效状态:0-表示有效、1-版本过期-续费页、2-版本不可用-购买页', 'type' => 'integer', 'format' => 'int32', 'example' => '87'],
],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取版本信息',
+ 'summary' => '获取用户购买的版本信息。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交内容聚合任务',
- ],
- 'GetDocClusterTask' => [
- 'summary' => '获取内容聚合任务结果。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListVersions'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": [\\n {\\n \\"ConcurrentCount\\": 43,\\n \\"EndTime\\": \\"2023-04-23 02:00:34\\",\\n \\"InstanceCount\\": 55,\\n \\"InstanceId\\": \\"ga-bp12pismsw4v3tzhf62p1\\",\\n \\"OrderId\\": 7,\\n \\"ProductType\\": \\"CUSTOMIZE\\",\\n \\"Quota\\": 13,\\n \\"StartTime\\": \\"2023-05-27 04:11:00\\",\\n \\"UseQuota\\": 65,\\n \\"VersionDetail\\": \\"标准版-公共并发:1并发\\",\\n \\"VersionName\\": \\"试用版\\",\\n \\"VersionStatus\\": 87\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ListWebReviewPoints' => [
+ 'summary' => '网友视角列表。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -25262,402 +16906,328 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'AgentKey',
'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '93771c8e1142467fb1aedf1763feba1e',
- ],
+ 'schema' => ['title' => '热榜源', 'description' => '热榜源', 'type' => 'string', 'required' => true, 'example' => '热榜源'],
+ ],
+ [
+ 'name' => 'Topic',
+ 'in' => 'formData',
+ 'schema' => ['title' => '热榜主题', 'description' => '热榜主题', 'type' => 'string', 'required' => true, 'example' => '热榜主题'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'required' => false, 'example' => '下一页的token'],
+ ],
+ [
+ 'name' => 'MaxResults',
+ 'in' => 'formData',
+ 'schema' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '0', 'example' => '81'],
],
],
'responses' => [
200 => [
'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PageResult2',
+ 'description' => 'PageResult2',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Status' => [
- 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'description' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'type' => 'string',
- 'example' => 'PENDING',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Attitude' => ['title' => '当前观点', 'description' => '当前观点', 'type' => 'string', 'example' => '当前观点'],
+ 'AttitudeType' => ['title' => '观点类型', 'description' => '观点类型', 'type' => 'string', 'example' => '观点类型'],
+ 'Comments' => [
+ 'title' => '网友评论列表',
+ 'description' => '网友观点列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '来源'],
+ 'Text' => ['title' => '评论内容', 'description' => '内容', 'type' => 'string', 'example' => '内容'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['title' => '当前评论所属的URL', 'description' => '当前所属的URL', 'type' => 'string', 'example' => '当前所属的URL'],
+ 'Username' => ['title' => '评论用户名', 'description' => '用户名', 'type' => 'string', 'example' => '用户名'],
+ ],
+ 'description' => '',
+ ],
],
- ],
- 'Topics' => [
- 'title' => '聚类主题列表',
- 'description' => '聚类主题列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '热点事件对象',
- 'type' => 'object',
- 'properties' => [
- 'DocIds' => [
- 'title' => '聚类主题下的文档ID列表',
- 'description' => '聚类主题下的文档ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'example' => 'xxxxx',
+ 'Ratio' => ['title' => '当前观点占比', 'description' => '当前观点占比', 'type' => 'string', 'example' => '当前观点占比'],
+ 'ViewPoints' => [
+ 'title' => '选题视角列表',
+ 'description' => '选题视角列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outlines' => [
+ 'title' => '大纲',
+ 'description' => '大纲',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'example' => '大纲'],
+ 'Summary' => ['title' => '大纲摘要', 'description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要'],
+ ],
+ 'description' => '',
+ ],
],
+ 'Point' => ['title' => '生成的视角', 'description' => '生成的视角', 'type' => 'string', 'example' => '视角'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '摘要'],
],
- 'Summary' => [
- 'title' => '聚类主题摘要',
- 'description' => '聚类主题摘要',
- 'type' => 'string',
- 'example' => '聚类主题摘要',
- ],
- 'Title' => [
- 'title' => '聚类主题名',
- 'description' => '聚类主题名',
- 'type' => 'string',
- 'example' => '聚类主题名',
- ],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'MaxResults' => ['title' => '最大返回结果数', 'description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '79'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'NextToken' => ['title' => '下一页的token', 'description' => '下一页的token', 'type' => 'string', 'example' => '下一页的token'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '32'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取网友视角列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Status\\": \\"PENDING\\",\\n \\"Topics\\": [\\n {\\n \\"DocIds\\": [\\n \\"xxxxx\\"\\n ],\\n \\"Summary\\": \\"聚类主题摘要\\",\\n \\"Title\\": \\"聚类主题名\\"\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取内容聚合任务结果',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListWebReviewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Comments\\": [\\n {\\n \\"Source\\": \\"来源\\",\\n \\"Text\\": \\"内容\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"当前所属的URL\\",\\n \\"Username\\": \\"用户名\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 79,\\n \\"Message\\": \\"success\\",\\n \\"NextToken\\": \\"下一页的token\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 32\\n}","type":"json"}]',
],
- 'SubmitTopicSelectionPerspectiveAnalysisTask' => [
- 'summary' => '提交选题热点分析任务。',
+ 'ListWritingStyles' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
+ 'name' => 'WorkspaceId',
'in' => 'query',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'],
+ ],
+ [
+ 'name' => 'Scene',
+ 'in' => 'formData',
'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
+ 'title' => '写作场景筛选',
+ 'description' => '写作场景筛选',
'type' => 'string',
'required' => true,
- 'example' => 'xxxxx_p_efm',
+ 'enumValueTitles' => ['market' => '营销写作', 'government' => '法定公文 ', 'custom' => '自定义写作', 'media' => '传媒类', 'office' => '事务公文'],
+ 'example' => 'media',
],
],
[
- 'name' => 'Documents',
+ 'name' => 'MaxResults',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '返回的最大结果数', 'description' => '返回的最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'],
+ ],
+ [
+ 'name' => 'NextToken',
+ 'in' => 'formData',
+ 'schema' => ['title' => '写一页Token', 'description' => '写一页Token', 'type' => 'string', 'required' => false, 'example' => '下一页token'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '待分析的文档列表。(documents与topic二者至少传一个)',
- 'description' => '待分析的文档列表。(documents与topic二者至少传一个)',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档列表信息',
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'required' => false,
- 'example' => '作者',
- 'maxLength' => 100,
- ],
- 'Comments' => [
- 'title' => '评论列表',
- 'description' => '内容列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '评论对象',
- 'description' => '对象',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '评论文本',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '内容',
- ],
- 'Username' => [
- 'title' => '用户名',
- 'description' => '用户名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用户名',
- ],
- ],
- 'required' => false,
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'TotalCount' => ['title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '58'],
+ 'MaxResults' => ['description' => '最大返回结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'NextToken' => ['title' => '下一个token', 'description' => '下一个token', 'type' => 'string', 'example' => '下一页token'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'successful'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '数据不存在'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'string', 'example' => 'true'],
+ 'Data' => [
+ 'title' => '文体列表',
+ 'description' => '文体列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '文体对象',
+ 'description' => '文体对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'StyleName' => ['title' => '文体名称', 'description' => '文体名称', 'type' => 'string', 'example' => '文体名称'],
+ 'StyleKey' => ['title' => '文体唯一标识KEY', 'description' => '文体唯一标识KEY', 'type' => 'string', 'example' => '文体唯一标识'],
+ 'StyleDescription' => ['title' => '文体描述', 'description' => '文体描述', 'type' => 'string', 'example' => '文体描述'],
+ 'DistributeWriting' => ['title' => '是否支持分步骤写作', 'description' => '是否支持分步骤写作', 'type' => 'boolean', 'example' => 'false'],
+ 'StyleImage' => ['title' => '文体图片', 'description' => '文体图片', 'type' => 'string', 'example' => '文体图片'."\n"
+ ."\n"],
+ 'Emoji' => ['title' => '文体小图标(字符符号表示)', 'description' => '文体小图标(字符符号表示)', 'type' => 'string', 'example' => '小图标'],
+ 'TemplateDefine' => ['description' => '文体模板定义', '$ref' => '#/components/schemas/WritingStyleTemplateDefine'],
+ 'DistributeStepTemplateDefine' => ['description' => '分步骤模板定义', '$ref' => '#/components/schemas/WritingStyleTemplateDefine'],
],
- 'required' => false,
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '文章内容',
- 'maxLength' => 3000,
- 'minLength' => 30,
- ],
- 'PubTime' => [
- 'title' => '发布时间。格式:YYYY-MM-dd HH:mm:ss',
- 'description' => '发布时间。格式:YYYY-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-22 10:29:00',
- 'maxLength' => 19,
- ],
- 'Source' => [
- 'title' => '文章来源',
- 'description' => '文章来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新浪',
- 'maxLength' => 40,
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章摘要',
- 'maxLength' => 200,
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- 'maxLength' => 100,
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- 'maxLength' => 1024,
],
],
- 'required' => false,
],
- 'required' => false,
- 'maxItems' => 30,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '获取写作文体列表',
+ 'summary' => '获取文体列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Topic',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '待分析的主题名(documents与topic二者至少传一个)',
- 'description' => '待分析的主题名(documents与topic二者至少传一个)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '待分析的主题名(documents与topic二者至少传一个)',
- 'maxLength' => 1000,
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListWritingStyles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"TotalCount\\": 58,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"下一页token\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"数据不存在\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"StyleName\\": \\"文体名称\\",\\n \\"StyleKey\\": \\"文体唯一标识\\",\\n \\"StyleDescription\\": \\"文体描述\\",\\n \\"DistributeWriting\\": false,\\n \\"StyleImage\\": \\"文体图片\\\\n\\\\n\\",\\n \\"Emoji\\": \\"小图标\\",\\n \\"TemplateDefine\\": {\\n \\"Fields\\": [\\n {\\n \\"MinItemLength\\": 1000,\\n \\"Max\\": 2000,\\n \\"MinLength\\": 20,\\n \\"MaxLength\\": 2000,\\n \\"MaxItemLength\\": 4000,\\n \\"Name\\": \\"字段名称\\",\\n \\"BuildIn\\": true,\\n \\"Enums\\": [\\n {\\n \\"CascadingFields\\": [\\n \\"级联字段\\"\\n ],\\n \\"Key\\": \\"枚举KEY\\",\\n \\"Name\\": \\"枚举名称\\"\\n }\\n ],\\n \\"Min\\": 1,\\n \\"Required\\": false,\\n \\"MaxItem\\": 10,\\n \\"InitialValue\\": \\"初始值\\",\\n \\"CascadingFields\\": [\\n {\\n \\"MinItemLength\\": 1000,\\n \\"Max\\": 2000,\\n \\"MinLength\\": 20,\\n \\"MaxLength\\": 2000,\\n \\"MaxItemLength\\": 4000,\\n \\"Name\\": \\"字段名称\\",\\n \\"BuildIn\\": true,\\n \\"Enums\\": [\\n {\\n \\"CascadingFields\\": [\\n \\"级联字段\\"\\n ],\\n \\"Key\\": \\"枚举KEY\\",\\n \\"Name\\": \\"枚举名称\\"\\n }\\n ],\\n \\"Min\\": 1,\\n \\"Required\\": false,\\n \\"MaxItem\\": 10,\\n \\"InitialValue\\": \\"初始值\\",\\n \\"CascadingFields\\": [\\n {\\n \\"MinItemLength\\": 1000,\\n \\"Max\\": 2000,\\n \\"MinLength\\": 20,\\n \\"MaxLength\\": 2000,\\n \\"MaxItemLength\\": 4000,\\n \\"Name\\": \\"字段名称\\",\\n \\"BuildIn\\": true,\\n \\"Enums\\": [\\n {\\n \\"CascadingFields\\": [\\n \\"级联字段\\"\\n ],\\n \\"Key\\": \\"枚举KEY\\",\\n \\"Name\\": \\"枚举名称\\"\\n }\\n ],\\n \\"Min\\": 1,\\n \\"Required\\": false,\\n \\"MaxItem\\": 10,\\n \\"InitialValue\\": \\"初始值\\",\\n \\"CascadingFields\\": [],\\n \\"Style\\": {\\n \\"Placeholder\\": \\"清输入Prompt\\",\\n \\"Type\\": \\"media\\",\\n \\"ShowTime\\": true,\\n \\"Suffix\\": \\"后缀\\",\\n \\"Description\\": \\"输入框提示文案\\",\\n \\"Format\\": \\"yyyy-mm-dd\\"\\n },\\n \\"Key\\": \\"topic\\"\\n }\\n ],\\n \\"Style\\": {\\n \\"Placeholder\\": \\"清输入Prompt\\",\\n \\"Type\\": \\"media\\",\\n \\"ShowTime\\": true,\\n \\"Suffix\\": \\"后缀\\",\\n \\"Description\\": \\"输入框提示文案\\",\\n \\"Format\\": \\"yyyy-mm-dd\\"\\n },\\n \\"Key\\": \\"topic\\"\\n }\\n ],\\n \\"Style\\": {\\n \\"Placeholder\\": \\"清输入Prompt\\",\\n \\"Type\\": \\"media\\",\\n \\"ShowTime\\": true,\\n \\"Suffix\\": \\"后缀\\",\\n \\"Description\\": \\"输入框提示文案\\",\\n \\"Format\\": \\"yyyy-mm-dd\\"\\n },\\n \\"Key\\": \\"topic\\"\\n }\\n ],\\n \\"Example\\": [\\n {\\n \\"Value\\": \\"123\\",\\n \\"Key\\": \\"topic\\"\\n }\\n ]\\n },\\n \\"DistributeStepTemplateDefine\\": {\\n \\"Fields\\": [],\\n \\"Example\\": [\\n {\\n \\"Value\\": \\"123\\",\\n \\"Key\\": \\"topic\\"\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'QueryAsyncTask' => [
+ 'summary' => '查询已提交异步任务执行明细。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
[
- 'name' => 'PerspectiveTypes',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'],
+ ],
+ [
+ 'name' => 'TaskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '要分析的选题视角任务,默认为空,空表示分析所有任务。 (TopicSummary: 主题事件摘要, HotViewPoints: 热门视角选题, TimedViewPoints: 时效视角选题, WebReviewPoints: 网评视角选题, FreshViewPoints: 新颖视角选题)',
- 'description' => '要分析的选题视角任务,默认为空,空表示分析所有任务。 (TopicSummary: 主题事件摘要, HotViewPoints: 热门视角选题, TimedViewPoints: 时效视角选题, WebReviewPoints: 网评视角选题, FreshViewPoints: 新颖视角选题)',
- 'type' => 'array',
- 'items' => [
- 'description' => '要分析的选题视角任务',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TopicSummary',
- 'enum' => [
- 'TopicSummary',
- 'HotViewPoints',
- 'TimedViewPoints',
- 'WebReviewPoints',
- 'FreshViewPoints',
- ],
- ],
- 'required' => false,
- 'example' => 'TimedViewPoints',
- ],
+ 'schema' => ['title' => '任务唯一ID', 'description' => '任务唯一ID'."\n"
+ ."\n"
+ .'>TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'PlainResult<AsyncTaskDO>',
+ 'description' => 'PlainResult<AsyncTaskDO>',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'success'],
'Data' => [
'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '任务名称',
- ],
+ 'CreateTime' => ['title' => '创建日期', 'description' => '创建日期', 'type' => 'string', 'example' => '2021-07-25 14:34:33'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => '"12121"'."\n"],
+ 'TaskCode' => ['title' => '任务标识,标识为哪一个任务', 'description' => '任务标识,标识为哪一个任务', 'type' => 'string', 'example' => 'MaterialDocumentUpload'],
+ 'TaskErrorMessage' => ['title' => '任务执行错误消息', 'description' => '任务执行错误消息', 'type' => 'string', 'example' => 'error'],
+ 'TaskId' => ['title' => '唯一任务ID', 'description' => '唯一任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskIntermediateResult' => ['title' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续', 'description' => '任务中间执行结果,当一个任务可分成多步骤时,每个步骤的输出,可保存在这里。后续从暂停中恢复可以读取中间结果,从中间结果继续', 'type' => 'string', 'example' => '"{}"'],
+ 'TaskName' => ['title' => '任务名', 'description' => '任务名', 'type' => 'string', 'example' => '任务名称'],
+ 'TaskParam' => ['title' => '任务执行输入参数,JSON格式', 'description' => '任务执行输入参数,JSON格式', 'type' => 'string', 'example' => '"{\\"fileKey\\":\\"oss://default/xxxx/xxxx/xxx\\",\\"fileName\\":\\"xxxxx.doc\\"}"'],
+ 'TaskProgressMessage' => ['title' => '任务执行进度信息', 'description' => '任务执行进度信息', 'type' => 'string', 'example' => '"{}"'],
+ 'TaskResult' => ['title' => '任务执行结果信息', 'description' => '任务执行结果信息', 'type' => 'string', 'example' => '"{}"'],
+ 'TaskRetryCount' => ['title' => '任务已经重试的次数', 'description' => '任务已经重试的次数', 'type' => 'string', 'example' => '"3"'],
+ 'TaskStatus' => ['title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'UpdateTime' => ['title' => '更新日期', 'description' => '更新日期', 'type' => 'string', 'example' => '2023-04-27 18:07:43'],
+ 'UpdateUser' => ['title' => '更新者', 'description' => '更新者', 'type' => 'string', 'example' => '"12121"'],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '867C4ABE-4381-5BC2-9810-5A5F334F71CF'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询异步任务明细',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交选题热点分析任务',
- ],
- 'GetTopicSelectionPerspectiveAnalysisTask' => [
- 'summary' => '获取选题视角分析任务结果。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAsyncTask'],
+ ],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:QueryAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"2021-07-25 14:34:33\\",\\n \\"CreateUser\\": \\"\\\\\\"12121\\\\\\"\\\\n\\",\\n \\"TaskCode\\": \\"MaterialDocumentUpload\\",\\n \\"TaskErrorMessage\\": \\"error\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskIntermediateResult\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"TaskParam\\": \\"\\\\\\"{\\\\\\\\\\\\\\"fileKey\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"oss://default/xxxx/xxxx/xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxxxx.doc\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"TaskProgressMessage\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"TaskResult\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"TaskRetryCount\\": \\"\\\\\\"3\\\\\\"\\",\\n \\"TaskStatus\\": 1,\\n \\"UpdateTime\\": \\"2023-04-27 18:07:43\\",\\n \\"UpdateUser\\": \\"\\\\\\"12121\\\\\\"\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"867C4ABE-4381-5BC2-9810-5A5F334F71CF\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'QueryAuditTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -25665,1722 +17235,824 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'ContentAuditTaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '审核任务ID(任务ID与文章ID二选一)', 'description' => '审核任务ID(任务ID与文章ID二选一)', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ArticleId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2',
- ],
+ 'schema' => ['title' => '文章ID(任务ID与文章ID二选一)', 'description' => '文章ID(任务ID与文章ID二选一)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxx'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'description' => '异步任务对象',
'type' => 'object',
'properties' => [
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'FreshViewPointsResult' => [
- 'title' => '新颖选题视角分析结果',
- 'description' => '新颖选题视角分析结果',
+ 'TaskStatus' => ['title' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败,6-任务取消', 'description' => '任务执行状态,0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败,6-任务取消', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Content' => ['title' => '审核时的原文', 'description' => '审核时的原文', 'type' => 'string', 'example' => '审核时的原文'],
+ 'AuditTime' => ['title' => '审核时间', 'description' => '审核时间', 'type' => 'string', 'example' => '2025-05-13 12:12:12'],
+ 'Response' => [
+ 'title' => '审核结果',
+ 'description' => '审核结果',
'type' => 'object',
'properties' => [
- 'Attitudes' => [
- 'title' => '新颖选题视角-观点列表',
- 'description' => '新颖选题视角-观点列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲列表',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
- ],
- ],
- ],
+ 'Header' => [
+ 'title' => '审核响应头',
+ 'description' => '审核响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'Event' => ['title' => '事件', 'description' => '事件', 'type' => 'string', 'example' => 'task-failed'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '数据不存在'],
+ 'SessionId' => ['title' => '对话唯一标识', 'description' => '对话唯一标识', 'type' => 'string', 'example' => '49eab783-9172-487a-b9df-c6372c47392c'],
+ 'TaskId' => ['title' => '多轮对话唯一标识', 'description' => '多轮对话唯一标识', 'type' => 'string', 'example' => '896b733535274d28b1a61c78bc145217'],
],
],
- ],
- ],
- 'HotViewPointsResult' => [
- 'title' => '热门选题视角分析结果',
- 'description' => '热门选题视角分析结果',
- 'type' => 'object',
- 'properties' => [
- 'Attitudes' => [
- 'title' => '热门选题视角-观点列表',
- 'description' => '热门选题视角-观点列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '热门选题视角-观点列表',
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'News' => [
- 'title' => '相关新闻列表',
- 'description' => '相关新闻列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '新闻对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'title' => '新闻内容',
- 'description' => '新闻内容',
- 'type' => 'string',
- 'example' => 'Content',
- ],
- 'DocId' => [
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '9957175DEDCF49C5ACF7A956B4FD67B2',
- ],
- 'DocUuid' => [
- 'title' => '文章唯一ID',
- 'description' => '文章唯一ID',
- 'type' => 'string',
- 'example' => '"123456"',
- ],
- 'ImageUrls' => [
- 'title' => '文章配图URL',
- 'description' => '文章配图URL',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章图片外链',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.png',
- ],
- 'example' => 'https://www.example.com/aaa.png',
- ],
- 'Source' => [
- 'title' => '新闻来源',
- 'description' => '新闻来源',
- 'type' => 'string',
- 'example' => '夸克',
- ],
- 'Summary' => [
- 'title' => '新闻摘要',
- 'description' => '新闻摘要',
- 'type' => 'string',
- 'example' => '新闻摘要',
- ],
- 'Tags' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章标签',
- 'type' => 'string',
- 'example' => '["标签1","标签2"]',
- ],
- 'example' => '["标签1","标签2"]',
- ],
- 'Title' => [
- 'title' => '新闻标题',
- 'description' => '新闻标题',
- 'type' => 'string',
- 'example' => '新闻标题',
- ],
- 'Topic' => [
- 'title' => '文章主题',
- 'description' => '文章主题',
- 'type' => 'string',
- 'example' => '文章主题',
- ],
- 'Url' => [
- 'title' => 'URL链接',
- 'description' => 'URL链接',
- 'type' => 'string',
- 'example' => 'http://www.example.com',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-05-08 02:23:01',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-05-08 02:23:02',
- ],
- ],
- ],
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '最终响应结果(json数组结构)', 'description' => '最终响应结果(json数组结构)', 'type' => 'string', 'example' => 'x\'x\'x'],
],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲对象',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
- ],
+ ],
+ 'Usage' => [
+ 'title' => '用量',
+ 'description' => '用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'OutputTokens' => ['title' => '输出token', 'description' => '输出token', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'InputTokens' => ['title' => '输入token', 'description' => '输入token', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TotalTokens' => ['title' => '总token', 'description' => '总token', 'type' => 'integer', 'format' => 'int32', 'example' => '300'],
],
],
],
],
],
],
+ 'Status' => ['title' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消', 'description' => '任务执行状态,PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消', 'type' => 'string', 'example' => 'RUNNING'],
+ 'HtmlContent' => ['title' => '格式化的审核时的内容', 'description' => '格式化的审核时的内容', 'type' => 'string', 'example' => '格式化的审核时的内容'."\n"
+ ."\n"],
+ 'Title' => ['title' => '内容标题', 'description' => '内容标题', 'type' => 'string', 'example' => '内容标题'."\n"
+ ."\n"],
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询审核结果',
+ 'summary' => '查询审核结果。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-15T10:00:27.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:QueryAuditTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskStatus\\": 1,\\n \\"Content\\": \\"审核时的原文\\",\\n \\"AuditTime\\": \\"2025-05-13 12:12:12\\",\\n \\"Response\\": {\\n \\"Header\\": {\\n \\"Event\\": \\"task-failed\\",\\n \\"ErrorCode\\": \\"DataNotExists\\",\\n \\"ErrorMessage\\": \\"数据不存在\\",\\n \\"SessionId\\": \\"49eab783-9172-487a-b9df-c6372c47392c\\",\\n \\"TaskId\\": \\"896b733535274d28b1a61c78bc145217\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"x\'x\'x\\"\\n },\\n \\"Usage\\": {\\n \\"OutputTokens\\": 100,\\n \\"InputTokens\\": 200,\\n \\"TotalTokens\\": 300\\n }\\n }\\n },\\n \\"Status\\": \\"RUNNING\\",\\n \\"HtmlContent\\": \\"格式化的审核时的内容\\\\n\\\\n\\",\\n \\"Title\\": \\"内容标题\\\\n\\\\n\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'QueryVideoAuditResult' => [
+ 'summary' => '查询视频审校结果',
+ 'description' => '根据任务ID查询视频审校结果,包含视频信息、分镜信息和审核结果',
+ 'path' => '/quanmiao/aimiaobi/pop/videoAudit/queryVideoAuditResult',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => '查询结果响应',
+ 'description' => '查询结果响应',
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'HttpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => '业务状态码', 'description' => '业务状态码', 'type' => 'string', 'example' => 'success'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息', 'type' => 'string', 'example' => '查询成功'],
+ 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'title' => '视频审校结果数据',
+ 'description' => '视频审校结果数据',
+ 'type' => 'object',
+ 'properties' => [
'Status' => [
- 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'description' => '任务状态(PENDING:待执行, RUNNING:执行中, SUCCESSED:成功, SUSPENDED:暂停, FAILED:失败, CANCELED:取消)',
+ 'title' => '任务状态',
+ 'description' => '任务状态(PENDING:排队中、RUNNING: 执行中,SUCCESSED: 执行成功、 FAILED: 执行失败、 CANCELED:任务被取消)',
'type' => 'string',
- 'example' => 'SUSPENDED',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
- ],
- ],
- 'TimedViewPointsResult' => [
- 'title' => '时效性选题视角分析结果',
- 'description' => '时效性选题视角分析结果',
- 'type' => 'object',
- 'properties' => [
- 'Attitudes' => [
- 'title' => '时效性选题视角-观点列表',
- 'description' => '时效性选题视角-观点列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '观点对象',
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-01-22 10:29',
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
- 'Source' => [
- 'title' => '新闻来源',
- 'description' => '新闻来源',
- 'type' => 'string',
- 'example' => '新浪',
- ],
- 'Title' => [
- 'title' => '当前观点 等价于 新闻标题',
- 'description' => '当前观点,等价于新闻标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'title' => '新闻URL',
- 'description' => '新闻URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/news/1.html',
- ],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '视角对象',
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲对象',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'example' => 'SUCCESSED',
+ 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'FAILED', 'CANCELED'],
+ ],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Text' => ['title' => '审校文本', 'description' => '审校文本', 'type' => 'string', 'example' => '视频审核完成'],
+ 'VideoUrl' => ['title' => '视频URL', 'description' => '视频URL', 'type' => 'string', 'example' => 'https://example.com/video.mp4'],
+ 'VideoFileKey' => ['title' => '视频FileKey', 'description' => '视频FileKey', 'type' => 'string', 'example' => 'video/test.mp4'],
+ 'Duration' => ['title' => '视频时长', 'description' => '视频时长', 'type' => 'number', 'format' => 'double', 'example' => '120.5'],
+ 'Width' => ['title' => '视频宽度', 'description' => '视频宽度', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'],
+ 'Height' => ['title' => '视频高度', 'description' => '视频高度', 'type' => 'integer', 'format' => 'int32', 'example' => '1080'],
+ 'Fps' => ['title' => '视频帧率', 'description' => '视频帧率', 'type' => 'number', 'format' => 'double', 'example' => '30.0'],
+ 'TotalFrames' => ['title' => '总帧数', 'description' => '总帧数', 'type' => 'integer', 'format' => 'int32', 'example' => '3615'],
+ 'TotalShots' => ['title' => '总分镜数', 'description' => '总分镜数', 'type' => 'integer', 'format' => 'int32', 'example' => '15'],
+ 'TotalFrameAudit' => ['title' => '待审核帧数', 'description' => '待审核帧数', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
+ 'FrameAudited' => ['title' => '已审帧数', 'description' => '已审帧数', 'type' => 'integer', 'format' => 'int32', 'example' => '120'],
+ 'ImageUrls' => [
+ 'title' => '图片URL列表',
+ 'description' => '图片URL列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => '图片URL', 'description' => '图片URL', 'type' => 'string', 'example' => 'https://example.com/image1.jpg'],
+ 'Id' => ['title' => '图片ID', 'description' => '图片ID(与Results[].DataId 关联获取 审核结果信息)', 'type' => 'string', 'example' => 'img001'],
+ 'Timestamp' => ['title' => '时间戳', 'description' => '时间戳(毫秒级)', 'type' => 'number', 'format' => 'double', 'example' => '1000'],
],
+ 'description' => '',
],
],
- 'Topic' => [
- 'title' => '热点主题事件',
- 'description' => '热点主题事件',
- 'type' => 'string',
- 'example' => '热点主题事件',
- ],
- 'TopicSummaryResult' => [
- 'title' => '热点主题事件摘要',
- 'description' => '热点主题事件摘要',
- 'type' => 'object',
- 'properties' => [
- 'Summaries' => [
- 'title' => '摘要列表',
- 'description' => '摘要列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '摘要对象',
- 'type' => 'object',
- 'properties' => [
- 'DocList' => [
- 'title' => '生成该标题摘要引用的文章',
- 'description' => '生成该标题摘要引用的文章',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章对象',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'description' => '文章源',
- 'type' => 'string',
- 'example' => '头条',
- ],
- 'Title' => [
- 'description' => '文章标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com',
- ],
- ],
- ],
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- ],
+ 'Results' => [
+ 'title' => '审核结果列表',
+ 'description' => '审核结果列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ReqId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => 'B5D1CF9E-0404-51E3-A28E-A5C7D95B6C71'],
+ 'DataId' => ['title' => '数据ID', 'description' => '图片ID(与 ImageUrls[].Id 关联 获取图片信息)', 'type' => 'string', 'example' => 'd411ed15e8fc154fd0ef5addabfee04b'],
+ 'RiskLevel' => [
+ 'title' => '风险等级',
+ 'description' => '风险等级'."\n"
+ ."\n"
+ .'- high: 高风险'."\n"
+ .'- medium:中风险'."\n"
+ .'- low:低风险'."\n"
+ .'- none:无风险',
+ 'type' => 'string',
+ 'example' => 'none',
+ 'enum' => ['high', 'medium', 'low', 'none'],
],
- ],
- ],
- ],
- 'WebReviewPointsResult' => [
- 'title' => '网评选题视角分析结果',
- 'description' => '网评选题视角分析结果',
- 'type' => 'object',
- 'properties' => [
- 'Attitudes' => [
- 'title' => '网友选题视角-观点列表',
- 'description' => '网友选题视角-观点列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'Comments' => [
- 'title' => '网友评论列表',
- 'description' => '网友观点列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '对象',
- 'type' => 'object',
- 'properties' => [
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '来源',
- ],
- 'Text' => [
- 'title' => '评论内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '内容',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'title' => '当前评论所属的URL',
- 'description' => '当前所属的URL',
- 'type' => 'string',
- 'example' => '当前所属的URL',
- ],
- 'Username' => [
- 'title' => '评论用户名',
- 'description' => '用户名',
- 'type' => 'string',
- 'example' => '用户名',
- ],
- ],
- ],
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'description' => '大纲对象',
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
- ],
+ 'Result' => [
+ 'title' => '检测结果',
+ 'description' => '检测结果',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Label' => ['title' => '风险标签', 'description' => '风险标签'."\n"
+ ."\n"
+ .'图片内容检测运算后返回的标签,如:nonLabel(未检测出风险)'."\n"
+ ."\n"
+ .'风险等级,根据设置的高低风险分返回,返回值包括:'."\n"
+ .'● high:高风险'."\n"
+ .'● medium:中风险'."\n"
+ .'● low:低风险'."\n"
+ .'● none:未检测到风险', 'type' => 'string', 'example' => 'nonLabel'],
+ 'Confidence' => ['title' => '置信分值', 'description' => '置信分值'."\n"
+ .'0到100分,保留到小数点后2位,部分标签无置信分', 'type' => 'number', 'format' => 'float', 'example' => '99.5'],
+ 'Description' => ['title' => '标签说明', 'description' => 'Label字段的解释说明', 'type' => 'string', 'example' => '未检测出风险'],
],
+ 'description' => '',
],
],
],
+ 'description' => '',
],
],
],
],
- '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',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"FreshViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"HotViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"News\\": [\\n {\\n \\"Content\\": \\"Content\\",\\n \\"DocId\\": \\"9957175DEDCF49C5ACF7A956B4FD67B2\\",\\n \\"DocUuid\\": \\"\\\\\\"123456\\\\\\"\\",\\n \\"ImageUrls\\": [\\n \\"https://www.example.com/aaa.png\\"\\n ],\\n \\"Source\\": \\"夸克\\",\\n \\"Summary\\": \\"新闻摘要\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"标签1\\\\\\",\\\\\\"标签2\\\\\\"]\\"\\n ],\\n \\"Title\\": \\"新闻标题\\",\\n \\"Topic\\": \\"文章主题\\",\\n \\"Url\\": \\"http://www.example.com\\",\\n \\"CreateTime\\": \\"2024-05-08 02:23:01\\",\\n \\"PubTime\\": \\"2024-05-08 02:23:02\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Status\\": \\"SUSPENDED\\",\\n \\"TimedViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"PubTime\\": \\"2024-01-22 10:29\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"Source\\": \\"新浪\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com/news/1.html\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Topic\\": \\"热点主题事件\\",\\n \\"TopicSummaryResult\\": {\\n \\"Summaries\\": [\\n {\\n \\"DocList\\": [\\n {\\n \\"Source\\": \\"头条\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com\\"\\n }\\n ],\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ]\\n },\\n \\"WebReviewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Comments\\": [\\n {\\n \\"Source\\": \\"来源\\",\\n \\"Text\\": \\"内容\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"当前所属的URL\\",\\n \\"Username\\": \\"用户名\\"\\n }\\n ],\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ]\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取选题视角分析任务结果',
- ],
- 'SubmitCustomTopicSelectionPerspectiveAnalysisTask' => [
- 'summary' => '提交自定义热点选题视角分析任务。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询视频审校结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:QueryVideoAuditResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"查询成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Text\\": \\"视频审核完成\\",\\n \\"VideoUrl\\": \\"https://example.com/video.mp4\\",\\n \\"VideoFileKey\\": \\"video/test.mp4\\",\\n \\"Duration\\": 120.5,\\n \\"Width\\": 1920,\\n \\"Height\\": 1080,\\n \\"Fps\\": 30,\\n \\"TotalFrames\\": 3615,\\n \\"TotalShots\\": 15,\\n \\"TotalFrameAudit\\": 120,\\n \\"FrameAudited\\": 120,\\n \\"ImageUrls\\": [\\n {\\n \\"Url\\": \\"https://example.com/image1.jpg\\",\\n \\"Id\\": \\"img001\\",\\n \\"Timestamp\\": 1000\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"ReqId\\": \\"B5D1CF9E-0404-51E3-A28E-A5C7D95B6C71\\",\\n \\"DataId\\": \\"d411ed15e8fc154fd0ef5addabfee04b\\",\\n \\"RiskLevel\\": \\"none\\",\\n \\"Result\\": [\\n {\\n \\"Label\\": \\"nonLabel\\",\\n \\"Confidence\\": 99.5,\\n \\"Description\\": \\"未检测出风险\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ ],
+ 'RunAbbreviationContent' => [
+ 'path' => '/quanmiao/aimiaobi/runAbbreviationContent',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'Documents',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '待分析的文档列表。',
- 'description' => '待分析的文档列表。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'required' => false,
- 'example' => '作者',
- 'maxLength' => 100,
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '文章内容',
- 'maxLength' => 3000,
- 'minLength' => 30,
- ],
- 'PubTime' => [
- 'title' => '发布时间。格式:YYYY-MM-dd HH:mm:ss',
- 'description' => '发布时间。格式:YYYY-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-01-22 10:29:00',
- 'maxLength' => 19,
- ],
- 'Source' => [
- 'title' => '文章来源',
- 'description' => '文章来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新浪',
- 'maxLength' => 40,
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章摘要',
- 'maxLength' => 200,
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- 'maxLength' => 100,
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- 'maxLength' => 1024,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- 'maxItems' => 30,
- ],
+ 'schema' => ['title' => '业务空间id', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'Topic',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'title' => '待分析的主题名',
- 'description' => '待分析的主题名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '待分析的主题名(documents与topic二者至少传一个)',
- 'maxLength' => 1000,
- ],
+ 'schema' => ['title' => '需要缩写的内容', 'description' => '需要缩写的内容', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。'],
],
[
'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '自定义观点的输入Prompt',
- 'description' => '自定义观点的输入Prompt',
- 'type' => 'string',
- 'required' => true,
- 'example' => '自定义观点的输入Prompt',
- 'maxLength' => 2000,
- ],
+ 'schema' => ['title' => '自定义提示词', 'description' => '自定义提示词', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ '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' => '模型生成事件'],
+ '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' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ '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' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
],
],
],
- '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',
- ],
+ 'RequestId' => ['title' => '请求唯一ID', 'description' => '请求唯一ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '内容缩写',
+ 'summary' => '内容缩写。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交自定义热点选题视角分析任务',
- ],
- 'GetCustomTopicSelectionPerspectiveAnalysisTask' => [
- 'summary' => '获取自定义选题视角分析任务结果。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunAbbreviationContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
+ ],
+ 'RunAiHelperWriting' => [
+ 'path' => '/quanmiao/aimiaobi/runAiHelperWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'autoTest' => true,
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'WritingScene',
+ 'in' => 'formData',
+ 'schema' => ['title' => '写作场景', 'description' => '写作场景:government(政务)、media(传媒)、market(营销)、office(办公)、custom(自定义)', 'type' => 'string', 'required' => true, 'example' => 'media'],
+ ],
+ [
+ 'name' => 'WritingStyle',
+ 'in' => 'formData',
+ 'schema' => ['title' => '写作文体', 'description' => '写作文体唯一标识KEY,可通过[ListWritingStyles](~~2922609~~)接口获取对应写作场景下的文体列表', 'type' => 'string', 'required' => true, 'example' => '通知'],
+ ],
+ [
+ 'name' => 'Prompt',
'in' => 'formData',
+ 'schema' => ['title' => '提示词,需要帮写的主题', 'description' => '提示词,需要帮写的主题', 'type' => 'string', 'required' => true, 'example' => '请帮我写一篇关于人工智能发展趋势的文章'],
+ ],
+ [
+ 'name' => 'PromptMode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '提示词模式,如:PE:高级模式,Template:模板模式', 'description' => '提示词模式,如:PE:高级模式,Template:模板模式', 'type' => 'string', 'required' => false, 'example' => 'Template'],
+ ],
+ [
+ 'name' => 'DistributeWriting',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否分步骤写作文体', 'description' => '是否分步骤写作文体', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'WritingParams',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0dbf1055f8a2475d99904c3b76a0ffba',
+ 'title' => '当前文体的表单的写作参数,键值对形式',
+ 'description' => '上一次表单的写作参数,键值对形式',
+ 'type' => 'object',
+ 'required' => false,
+ 'additionalProperties' => ['title' => '写作参数KEY VALUE', 'description' => '写作参数KEY VALUE', 'type' => 'string', 'example' => '{"topic":"写作主题"}'],
+ 'example' => '{"wordCount": "1000", "tone": "formal"}',
],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'Header' => [
+ 'title' => 'SSE响应头信息',
+ 'description' => 'SSE响应头信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'InvalidParameter'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '参数错误'],
+ 'Event' => ['title' => '事件类型', 'description' => '事件类型', 'type' => 'string', 'example' => 'result-generated'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => 'session-xxxxx'],
+ 'StatusCode' => ['title' => '状态码', 'description' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'task-xxxxx'],
+ 'TraceId' => ['title' => '链路追踪ID', 'description' => '链路追踪ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ ],
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Payload' => [
+ 'title' => '响应载荷',
+ 'description' => '响应载荷',
'type' => 'object',
'properties' => [
- 'CustomViewPointsResult' => [
- 'title' => '自定义选题分析任务结果',
- 'description' => '自定义选题分析任务结果',
+ 'Output' => [
+ 'title' => '输出内容',
+ 'description' => '输出内容',
'type' => 'object',
'properties' => [
- 'Attitudes' => [
- 'title' => '自定义观点列表。默认会根据Prompt输入生成一个观点',
- 'description' => '自定义观点列表。默认会根据Prompt输入生成一个观点',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Attitude' => [
- 'title' => '当前观点',
- 'description' => '当前观点',
- 'type' => 'string',
- 'example' => '当前观点',
- ],
- 'AttitudeType' => [
- 'title' => '观点类型',
- 'description' => '观点类型',
- 'type' => 'string',
- 'example' => '观点类型',
- ],
- 'Ratio' => [
- 'title' => '当前观点占比',
- 'description' => '当前观点占比',
- 'type' => 'string',
- 'example' => '当前观点占比',
- ],
- 'ViewPoints' => [
- 'title' => '选题视角列表',
- 'description' => '选题视角列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outlines' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Outline' => [
- 'title' => '大纲',
- 'description' => '大纲',
- 'type' => 'string',
- 'example' => '大纲',
- ],
- 'Summary' => [
- 'title' => '大纲摘要',
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要',
- ],
- ],
- ],
- ],
- 'Point' => [
- 'title' => '生成的视角',
- 'description' => '生成的视角',
- 'type' => 'string',
- 'example' => '视角',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'Topic' => [
- 'title' => '热点主题事件',
- 'description' => '热点主题事件',
- 'type' => 'string',
- 'example' => '热点主题事件',
+ 'Text' => ['title' => '生成文本', 'description' => '生成文本', 'type' => 'string', 'example' => '人工智能正在深刻改变我们的生活...'],
+ 'WritingParams' => [
+ 'title' => 'AI帮写的写作参数',
+ 'description' => 'AI帮写的写作参数',
+ 'type' => 'object',
+ 'additionalProperties' => ['title' => 'KEY VALUE形式的键值对', 'description' => 'KEY VALUE形式的键值对', 'type' => 'string', 'example' => '{"topic":"写作主题xxx"}'],
+ 'example' => '{"wordCount": "1000"}',
],
],
],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Status' => [
- 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'description' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'type' => 'string',
- 'example' => 'FAILED',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
+ 'Usage' => [
+ 'title' => 'Token使用量',
+ 'description' => 'Token使用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['title' => '输入Token数', 'description' => '输入Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '256'],
+ 'OutputTokens' => ['title' => '输出Token数', 'description' => '输出Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'],
+ 'TotalTokens' => ['title' => '总Token数', 'description' => '总Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '1280'],
],
],
],
],
- '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',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'HttpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'string', 'example' => '200'],
+ 'Code' => ['title' => '业务状态码', 'description' => '业务状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"CustomViewPointsResult\\": {\\n \\"Attitudes\\": [\\n {\\n \\"Attitude\\": \\"当前观点\\",\\n \\"AttitudeType\\": \\"观点类型\\",\\n \\"Ratio\\": \\"当前观点占比\\",\\n \\"ViewPoints\\": [\\n {\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"大纲摘要\\"\\n }\\n ],\\n \\"Point\\": \\"视角\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n ],\\n \\"Topic\\": \\"热点主题事件\\"\\n },\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Status\\": \\"FAILED\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取自定义选题视角分析任务结果',
- ],
- 'GetHotTopicBroadcast' => [
- 'summary' => '查询新闻播报单。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'AI帮写',
+ 'summary' => '妙笔:AI助手写作',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'requestParamsDescription' => '## 示例数据'."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "WorkspaceId": "llm-xxx",'."\n"
+ .' "WritingScene": "office",'."\n"
+ .' "WritingStyle": "speech",'."\n"
+ .' "Prompt": "关于“人工智能伦理与社会影响”主题的演讲稿"'."\n"
+ .'}'."\n"
+ .'```',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunAiHelperWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"InvalidParameter\\",\\n \\"ErrorMessage\\": \\"参数错误\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"SessionId\\": \\"session-xxxxx\\",\\n \\"StatusCode\\": 200,\\n \\"TaskId\\": \\"task-xxxxx\\",\\n \\"TraceId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"人工智能正在深刻改变我们的生活...\\",\\n \\"WritingParams\\": {\\n \\"key\\": \\"{\\\\\\"topic\\\\\\":\\\\\\"写作主题xxx\\\\\\"}\\"\\n }\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 256,\\n \\"OutputTokens\\": 1024,\\n \\"TotalTokens\\": 1280\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'RunBookBrainmap' => [
+ 'summary' => '妙读生成书籍脑图。',
+ 'path' => '/miaodu/stream/runBookBrainmap',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREsfmJIZ0TW',
- ],
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-hx72jf15gqyobvd9', 'title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)'],
],
[
- 'name' => 'HotTopicVersion',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点版本',
- 'description' => '热点版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-10-11_13',
- ],
+ 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => '会话ID。'],
],
[
- 'name' => 'Topics',
+ 'name' => 'DocId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '话题筛选',
- 'description' => '话题筛选',
- 'type' => 'array',
- 'items' => [
- 'description' => '热点主题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["主题1","主题2"]',
- ],
- 'required' => false,
- 'example' => '["主题1","主题2"]',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => '文档ID'],
],
[
- 'name' => 'CalcTotalToken',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否计算总Token数',
- 'description' => '是否计算总Token数',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'schema' => ['description' => '附加要求提示词', 'type' => 'string', 'required' => false, 'example' => '按英文输出', 'title' => '附加要求提示词'],
],
[
- 'name' => 'Category',
+ 'name' => 'CleanCache',
'in' => 'formData',
- 'schema' => [
- 'title' => '分类筛选',
- 'description' => '分类筛选',
- 'type' => 'string',
- 'required' => false,
- 'example' => '分类筛选',
- ],
+ 'schema' => ['description' => '是否清理掉之前的缓存', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => '是否清理掉之前的缓存'],
],
[
- 'name' => 'StepForNewsBroadcastContentConfig',
+ 'name' => 'NodeNumber',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => '第二级有几个节点', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => '第二级有几个节点'],
+ ],
+ [
+ 'name' => 'WordNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => '节点文字的个数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => '节点文字的个数'],
+ ],
+ [
+ 'name' => 'ResponseFormat',
+ 'in' => 'formData',
+ 'schema' => ['title' => '返回值的格式版本,0-没有定位信息脑图,1-有定位信息脑图', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '热点播报单内容配置',
- 'description' => '热点播报单内容配置',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Categories' => [
- 'title' => '选择的频道列表',
- 'description' => '选择的频道列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '频道',
- 'type' => 'string',
- 'required' => false,
- 'example' => '["科技","经济","时政","娱乐"]',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'Success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'task-failed'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0bc1409b17210096103458421ec62e'],
],
- 'required' => false,
- 'example' => '["科技","经济","时政","娱乐"]',
],
- 'CustomHotValueWeights' => [
- 'title' => '自定义热度权重(此参数已过时,不生效。不用传递此参数)',
- 'description' => '自定义热度权重',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义权重',
- 'type' => 'object',
- 'properties' => [
- 'Dimension' => [
- 'title' => '维度KEY',
- 'description' => '维度KEY',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'views',
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '脑图内容', 'type' => 'string', 'example' => '{"xxxx":"xxx"}'],
],
- 'Weight' => [
- 'title' => '权重',
- 'description' => '权重',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ 'Usage' => [
+ 'description' => 'token消耗',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
- 'required' => false,
],
- 'deprecated' => true,
- 'required' => false,
- ],
- 'TopicCount' => [
- 'title' => '话题数量',
- 'description' => '话题数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
],
],
- 'required' => false,
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '书籍脑图',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'StepForCustomSummaryStyleConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '自定义输出风格配置',
- 'description' => '自定义输出风格配置',
- 'type' => 'object',
- 'properties' => [
- 'SummaryImageCount' => [
- 'title' => '摘要-配图数量',
- 'description' => '摘要-配图数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '90',
- ],
- 'SummaryModel' => [
- 'title' => '摘要模型',
- 'description' => '摘要模型',
- 'type' => 'string',
- 'required' => false,
- 'example' => '摘要模型',
- ],
- 'SummaryPrompt' => [
- 'title' => '摘要-自定义Prompt',
- 'description' => '摘要-自定义Prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '摘要-自定义Prompt',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunBookBrainmap',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0bc1409b17210096103458421ec62e\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"{\\\\\\"xxxx\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunBookIntroduction' => [
+ 'summary' => '基于一本书,抽取书籍的内容概要,以及结构化的卖点、热词信息。',
+ 'path' => '/miaodu/stream/runBookIntroduction',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
[
- 'name' => 'Size',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页大小。最大200',
- 'description' => '每页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-vtmox6g2bhq2qv5c', 'title' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)'],
],
[
- 'name' => 'Current',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '3YQRatoe8phnpIsIE6z7DTPknhG8Fj', 'title' => '文档ID'],
],
[
- 'name' => 'Locations',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '新闻地域检索(keyword过滤)',
- 'description' => '新闻地域检索列表(keyword过滤)',
- 'type' => 'array',
- 'items' => [
- 'description' => '新闻地域检索(keyword过滤)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '重庆',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => '0f56f98a-f2d8-47ec-98e9-1cbdcffa9539', 'title' => '对话ID'],
],
[
- 'name' => 'LocationQuery',
+ 'name' => 'SummaryPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点地域的全文检索(该参数存在时current不生效)',
- 'description' => '热点地域的全文检索(该参数存在时current不生效)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '重庆 成都 浙江 杭州',
- ],
+ 'schema' => ['description' => '总结自定义要求', 'type' => 'string', 'required' => false, 'example' => '用英文输出', 'title' => '总结自定义要求'],
],
[
- 'name' => 'Query',
+ 'name' => 'KeyPointPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '全文检索(针对标题、热点摘要、地域的全文检索)(该参数存在时current不生效)',
- 'description' => '全文检索(针对标题、热点摘要、地域的全文检索)(该参数存在时current不生效)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '重庆新闻',
- ],
+ 'schema' => ['description' => '关键点自定义要求', 'type' => 'string', 'required' => false, 'example' => '用英文输出', 'title' => '关键点自定义要求'],
+ ],
+ [
+ 'name' => 'CleanCache',
+ 'in' => 'formData',
+ 'schema' => ['title' => '清除缓存', 'type' => 'boolean', 'example' => 'true'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success', 'title' => '错误码'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success', 'title' => '错误信息。'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'finished', 'title' => '事件类型'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件', 'title' => '事件描述'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '411c4dfa-2168-4379-a902-675d67f453f8', 'title' => '会话ID'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99', 'title' => '任务ID'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b', 'title' => '全链路ID'],
+ ],
+ 'title' => '响应头',
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '热点播报单列表信息',
- 'description' => '热点播报单列表信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '热点信息',
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'title' => '热点话题分类',
- 'description' => '热点话题分类',
- 'type' => 'string',
- 'example' => '热点话题分类',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '创建时间',
- ],
- 'CustomHotValue' => [
- 'title' => '自定义热度值',
- 'description' => '自定义热度值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '34.7905341705522',
- ],
- 'CustomTextSummary' => [
- 'title' => '自定义热点话题文本摘要',
- 'description' => '自定义热点话题文本摘要',
- 'type' => 'string',
- 'example' => '自定义热点话题文本摘要',
- ],
- 'HotTopic' => [
- 'title' => '热点话题名称',
- 'description' => '热点话题名称',
- 'type' => 'string',
- 'example' => '热点话题名称',
- ],
- 'HotTopicVersion' => [
- 'title' => '热点话题摘要版本',
- 'description' => '热点话题摘要版本',
- 'type' => 'string',
- 'example' => '热点话题摘要版本',
- ],
- 'HotValue' => [
- 'title' => '热度值',
- 'description' => '热度值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1.4120480606282884',
- ],
- 'Id' => [
- 'title' => '热点话题ID',
- 'description' => '热点话题ID',
- 'type' => 'string',
- 'example' => '热点话题ID',
- ],
- 'Images' => [
- 'title' => '热点话题图片列表',
- 'description' => '热点话题图片列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片对象',
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'description' => 'URL链接',
- 'type' => 'string',
- 'example' => 'http://www.example.com/a.png',
- ],
- ],
- ],
- ],
- 'InputToken' => [
- 'title' => '输入token',
- 'description' => '输入Token',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '29',
- ],
- 'News' => [
- 'title' => '文章列表',
- 'description' => '文章列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '新闻对象',
- 'type' => 'object',
- 'properties' => [
- 'AnalysisCategory' => [
- 'description' => '模型分类结果',
- 'type' => 'string',
- 'example' => '科技',
- ],
- 'AnalysisTopic' => [
- 'title' => '聚合后热点名称',
- 'description' => '聚合后热点名称',
- 'type' => 'string',
- 'example' => '聚合后热点名称',
- ],
- 'Author' => [
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Category' => [
- 'title' => '分类',
- 'description' => '分类',
- 'type' => 'array',
- 'items' => [
- 'description' => '分类',
- 'type' => 'string',
- 'example' => '科技',
- ],
- ],
- 'Comments' => [
- 'title' => '新闻评论',
- 'description' => '新闻内容',
- 'type' => 'array',
- 'items' => [
- 'description' => '对象',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '评论内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '内容',
- ],
- 'Username' => [
- 'title' => '评论用户名',
- 'description' => '用户名',
- 'type' => 'string',
- 'example' => '用户名',
- ],
- ],
- ],
- ],
- 'Content' => [
- 'description' => '新闻内容',
- 'type' => 'string',
- 'example' => '新闻内容'."\n"
- ."\n",
- ],
- 'CreateTime' => [
- 'description' => '入库时间',
- 'type' => 'string',
- 'example' => '2024-06-13 08:45:05',
- ],
- 'Domain' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '夸克',
- ],
- 'Dt' => [
- 'description' => '入库日期',
- 'type' => 'string',
- 'example' => '2024111110',
- ],
- 'HotTopic' => [
- 'title' => '原始热点名称',
- 'description' => '原始热点名称',
- 'type' => 'string',
- 'example' => '原始热点名称',
- ],
- 'ImgList' => [
- 'description' => '图片列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/a.png',
- ],
- ],
- 'Logo' => [
- 'description' => 'logo',
- 'type' => 'string',
- 'example' => 'https://www.example.com/a.png',
- ],
- 'PubTime' => [
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-10-10 12:12:00',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'description' => '新闻URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/a.png',
- ],
- 'Uuid' => [
- 'title' => '主键ID',
- 'description' => '主键ID',
- 'type' => 'string',
- 'example' => '主键ID',
- ],
- 'Website' => [
- 'title' => '网站',
- 'description' => '网站',
- 'type' => 'string',
- 'example' => '网站',
- ],
- ],
- ],
- ],
- 'OutputToken' => [
- 'title' => '输出token',
- 'description' => '输出Token',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '22',
- ],
- 'Summary' => [
- 'title' => '热点话题结构化摘要',
- 'description' => '热点话题结构化摘要',
+ 'Output' => [
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Summary' => ['description' => '书籍简介', 'type' => 'string', 'example' => '简介内容', 'title' => '书籍简介'],
+ 'KeyPoint' => ['description' => '书籍卖点', 'type' => 'string', 'example' => '卖点内容', 'title' => '书籍卖点'],
+ 'Introductions' => [
+ 'title' => '分段导读内容数组',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '分段导读内容数组',
'type' => 'object',
'properties' => [
- 'InputToken' => [
- 'description' => '生成此摘要的输入Token数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '17',
- ],
- 'OutputToken' => [
- 'description' => '生成此摘要的输出Token数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '41',
- ],
- 'Summaries' => [
- 'description' => '结构化摘要列表',
+ 'Summary' => ['title' => '本段摘要', 'type' => 'string', 'example' => '本段摘要内容'],
+ 'Title' => ['title' => '本段标题', 'type' => 'string', 'example' => '本段标题内容'],
+ 'Blocks' => [
+ 'title' => '位置信息',
'type' => 'array',
'items' => [
- 'description' => '结构化摘要',
+ 'title' => '位置信息',
'type' => 'object',
'properties' => [
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => '摘要',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
+ 'Height' => ['title' => '文本块高', 'type' => 'integer', 'format' => 'int32', 'example' => '600'],
+ 'PageId' => ['title' => '文本块所在页号', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Width' => ['title' => '文本块宽', 'type' => 'integer', 'format' => 'int32', 'example' => '600'],
+ 'X' => ['title' => '块左上角X坐标', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Y' => ['title' => '块左上角Y坐标', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'BeginTime' => ['title' => '段落开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'EndTime' => ['title' => '段落结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1200'],
],
],
],
],
],
- 'TextSummary' => [
- 'title' => '热点话题文本摘要',
- 'description' => '热点话题文本摘要',
- 'type' => 'string',
- 'example' => '热点话题文本摘要',
- ],
- 'Locations' => [
- 'title' => '热点的地域信息',
- 'description' => '热点的地域信息列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '地域信息',
- 'description' => '热点的地域信息',
- 'type' => 'string',
- 'example' => '成都',
- ],
- ],
- 'Url' => [
- 'title' => '热榜URL',
- 'description' => '热榜URL',
- 'type' => 'string',
- 'example' => 'http://www.example.com/a.html',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2025-08-01 12:00:00',
- ],
],
],
+ 'title' => '输出内容对象',
],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TotalTokenInfo' => [
- 'title' => '全部生成预计所需要的Token数',
- 'description' => '全部生成预计所需要的Token数',
+ 'Usage' => [
+ 'description' => 'token用量',
'type' => 'object',
'properties' => [
- 'HotTopicCount' => [
- 'title' => '热点总数',
- 'description' => '热点总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'InputTokens' => [
- 'title' => '预计输入token数',
- 'description' => '预计输入Token数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'OutputTokens' => [
- 'title' => '预计输出token数',
- 'description' => '预计输出Token数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'WordCount' => [
- 'title' => '预计总字数',
- 'description' => '预计总字数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '输入Token数量'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '输出Token数量'],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => '总Token数量'],
],
+ 'title' => 'token用量',
],
],
- ],
- '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',
+ 'title' => '响应体',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Data\\": [\\n {\\n \\"Category\\": \\"热点话题分类\\",\\n \\"CreateTime\\": \\"创建时间\\",\\n \\"CustomHotValue\\": 34.7905341705522,\\n \\"CustomTextSummary\\": \\"自定义热点话题文本摘要\\",\\n \\"HotTopic\\": \\"热点话题名称\\",\\n \\"HotTopicVersion\\": \\"热点话题摘要版本\\",\\n \\"HotValue\\": 1.4120480606282884,\\n \\"Id\\": \\"热点话题ID\\",\\n \\"Images\\": [\\n {\\n \\"Url\\": \\"http://www.example.com/a.png\\"\\n }\\n ],\\n \\"InputToken\\": 29,\\n \\"News\\": [\\n {\\n \\"AnalysisCategory\\": \\"科技\\",\\n \\"AnalysisTopic\\": \\"聚合后热点名称\\",\\n \\"Author\\": \\"作者\\",\\n \\"Category\\": [\\n \\"科技\\"\\n ],\\n \\"Comments\\": [\\n {\\n \\"Text\\": \\"内容\\",\\n \\"Username\\": \\"用户名\\"\\n }\\n ],\\n \\"Content\\": \\"新闻内容\\\\n\\\\n\\",\\n \\"CreateTime\\": \\"2024-06-13 08:45:05\\",\\n \\"Domain\\": \\"夸克\\",\\n \\"Dt\\": \\"2024111110\\",\\n \\"HotTopic\\": \\"原始热点名称\\",\\n \\"ImgList\\": [\\n \\"http://www.example.com/a.png\\"\\n ],\\n \\"Logo\\": \\"https://www.example.com/a.png\\",\\n \\"PubTime\\": \\"2024-10-10 12:12:00\\",\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"http://www.example.com/a.png\\",\\n \\"Uuid\\": \\"主键ID\\",\\n \\"Website\\": \\"网站\\"\\n }\\n ],\\n \\"OutputToken\\": 22,\\n \\"Summary\\": {\\n \\"InputToken\\": 17,\\n \\"OutputToken\\": 41,\\n \\"Summaries\\": [\\n {\\n \\"Summary\\": \\"摘要\\",\\n \\"Title\\": \\"标题\\"\\n }\\n ]\\n },\\n \\"TextSummary\\": \\"热点话题文本摘要\\",\\n \\"Locations\\": [\\n \\"成都\\"\\n ],\\n \\"Url\\": \\"http://www.example.com/a.html\\",\\n \\"PubTime\\": \\"2025-08-01 12:00:00\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"TotalTokenInfo\\": {\\n \\"HotTopicCount\\": 100,\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"WordCount\\": 100\\n }\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询完整播报单(热榜)',
- ],
- 'SubmitCustomHotTopicBroadcastJob' => [
- 'summary' => '提交自定义播报单任务。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '书籍导读(抽取书籍卖点/书籍摘要)',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunBookIntroduction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"411c4dfa-2168-4379-a902-675d67f453f8\\",\\n \\"TaskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"TraceId\\": \\"46e5c2b5-0877-4f09-bd91-ab0cf314e48b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Summary\\": \\"简介内容\\",\\n \\"KeyPoint\\": \\"卖点内容\\",\\n \\"Introductions\\": [\\n {\\n \\"Summary\\": \\"本段摘要内容\\",\\n \\"Title\\": \\"本段标题内容\\",\\n \\"Blocks\\": [\\n {\\n \\"Height\\": 600,\\n \\"PageId\\": 10,\\n \\"Width\\": 600,\\n \\"X\\": 10,\\n \\"Y\\": 10,\\n \\"BeginTime\\": 0,\\n \\"EndTime\\": 1200\\n }\\n ]\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunBookSmartCard' => [
+ 'path' => '/miaodu/stream/runBookSmartCard',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -27388,1110 +18060,831 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'HotTopicBroadcastConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '新闻播报单配置',
- 'description' => '新闻播报单配置',
- 'type' => 'object',
- 'properties' => [
- 'StepForNewsBroadcastContentConfig' => [
- 'title' => '配置播报单内容',
- 'description' => '配置播报单内容',
- 'type' => 'object',
- 'properties' => [
- 'Categories' => [
- 'title' => '选择的频道列表',
- 'description' => '选择的频道列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '频道',
- 'type' => 'string',
- 'required' => false,
- 'example' => '科技',
- ],
- 'required' => false,
- 'example' => '["科技","经济","时政","娱乐"]',
- ],
- 'CustomHotValueWeights' => [
- 'title' => '自定义热度权重',
- 'description' => '自定义热度权重',
- 'type' => 'array',
- 'items' => [
- 'description' => '自定义权重',
- 'type' => 'object',
- 'properties' => [
- 'Dimension' => [
- 'title' => '维度KEY',
- 'description' => '维度KEY',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'views',
- ],
- 'DimensionName' => [
- 'title' => '维度名称',
- 'description' => '维度名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '维度名称',
- ],
- 'Weight' => [
- 'title' => '权重',
- 'description' => '权重',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'TopicCount' => [
- 'title' => '话题数量',
- 'description' => '话题数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- 'required' => true,
- ],
- 'StepForCustomSummaryStyleConfig' => [
- 'title' => '自定义输出风格配置',
- 'description' => '自定义输出风格配置',
- 'type' => 'object',
- 'properties' => [
- 'SummaryImageCount' => [
- 'title' => '摘要-配图数量',
- 'description' => '摘要-配图数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- 'SummaryModel' => [
- 'title' => '摘要模型',
- 'description' => '摘要模型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'qwen-max',
- ],
- 'SummaryPrompt' => [
- 'title' => '摘要-自定义Prompt',
- 'description' => '摘要-自定义Prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- 'required' => true,
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'HotTopicVersion',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '热点版本',
- 'description' => '热点版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热点版本',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55'],
],
[
- 'name' => 'Topics',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '话题筛选',
- 'description' => '话题筛选',
- 'type' => 'array',
- 'items' => [
- 'description' => '热点主题名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '热点主题名称',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'finished'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '1a0e898717105546647125853d4f54'],
+ ],
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'Output' => [
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '卡片标题', 'type' => 'string', 'example' => '卡片标题内容'],
+ 'Tags' => [
+ 'description' => '卡片标签数组',
+ 'type' => 'array',
+ 'items' => ['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' => '100'],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
+ ],
],
],
],
- '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',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交自定义播报单任务',
- ],
- 'GetCustomHotTopicBroadcastJob' => [
- 'summary' => '获取自定义播报单任务结果。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '书籍智能卡片',
+ 'summary' => '书籍智能卡片接口。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunBookSmartCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"1a0e898717105546647125853d4f54\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"卡片标题内容\\",\\n \\"Tags\\": [\\n \\"卡片标签内容\\"\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 101\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunCommentGeneration' => [
+ 'path' => '/quanmiao/aimiaobi/runCommentGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '路径参数,阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-3kcs1w3lltrtbfkr'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2e27abb32cb64f80a0c6e829b6c87a09',
- ],
+ 'schema' => ['description' => '对话Id', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
+ [
+ 'name' => 'Length',
+ 'in' => 'formData',
+ 'schema' => ['description' => '一条评论的长度', 'type' => 'string', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'NumComments',
+ 'in' => 'formData',
+ 'schema' => ['description' => '评论的条数', 'type' => 'string', 'required' => true, 'example' => '10'],
+ ],
+ [
+ 'name' => 'Style',
+ 'in' => 'formData',
+ 'schema' => ['description' => '评论的风格', 'type' => 'string', 'required' => false, 'example' => '积极正面'."\n"],
+ ],
+ [
+ 'name' => 'SourceMaterial',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要评论的文章', 'type' => 'string', 'required' => true, 'example' => 'ps5是sony新一代的游戏机,他创新性的...'."\n"],
+ ],
+ [
+ 'name' => 'AllowEmoji',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否允许使用表情默认为false', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'Type',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => '评论类型'."\n"
+ ."\n"
+ .' key 可选值'."\n"
+ ."\n"
+ .' * emotion (情感表达型)'."\n"
+ .' * opinion (观点阐述型)'."\n"
+ .' * interaction (互动交流型)'."\n"
+ .' * experience (经验分享型)'."\n"
+ .' * humor (幽默调侃型)', 'type' => 'object', 'required' => true, 'example' => '{"emotion":"50","opinion":"50"}'."\n"],
+ ],
+ [
+ 'name' => 'Sentiment',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => '情感倾向'."\n"
+ ."\n"
+ .' key 可选值'."\n"
+ ."\n"
+ .' * positive (正向)'."\n"
+ .' * neutral (中立)'."\n"
+ .' * negative (负向)', 'type' => 'object', 'required' => true, 'example' => '{"positive":"50","negative":"50"}'."\n"],
+ ],
+ [
+ 'name' => 'LengthRange',
+ 'in' => 'formData',
+ 'style' => 'json',
+ 'schema' => ['description' => '长度范围'."\n"
+ ."\n"
+ .' key 可选值'."\n"
+ ."\n"
+ .' * short (20字以内)'."\n"
+ .' * medium (20-50字)'."\n"
+ .' * long (50-100字)', 'type' => 'object', 'required' => true, 'example' => '{"short":"50","long":“50”}'."\n"],
+ ],
+ [
+ 'name' => 'ExtraInfo',
+ 'in' => 'formData',
+ 'schema' => ['description' => '补充要求', 'type' => 'string', 'required' => false, 'example' => '不要输出额外其他信息'."\n"],
+ ],
+ [
+ 'name' => 'ModelId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '模型id', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'End' => ['description' => '是否结束', 'type' => 'boolean'],
+ 'Header' => [
+ 'description' => '返回结果的header',
+ 'type' => 'object',
+ 'properties' => [
+ 'Event' => ['description' => 'event名称', 'type' => 'string', 'example' => 'result-generated'."\n"],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '可空'."\n"],
+ 'RequestId' => ['description' => '请求RequestId', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'SessionId' => ['description' => '对话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0bd58ea2-dc38-45da-ac02-17f05cb9040b'],
+ ],
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'HotTopicVersion' => [
- 'title' => '热点话题版本号标识',
- 'description' => '热点话题版本号标识',
- 'type' => 'string',
- 'example' => '热点话题版本号标识',
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => '输出内容', 'type' => 'string', 'example' => '评论内容'],
+ ],
],
- 'Status' => [
- 'title' => '任务状态 (PENDING: 待执行, RUNNING: 执行中, SUCCESSED: 成功, SUSPENDED: 暂停, FAILED: 失败, CANCELED: 取消)',
- 'description' => '任务状态 '."\n"
- ."\n"
- .'- PENDING:待执行'."\n"
- .'- RUNNING:执行中'."\n"
- .'- SUCCESSED:成功'."\n"
- .'- SUSPENDED:暂停'."\n"
- .'- FAILED:失败'."\n"
- .'- CANCELED:取消',
- 'type' => 'string',
- 'example' => 'RUNNING',
- 'enum' => [
- 'PENDING',
- 'RUNNING',
- 'SUCCESSED',
- 'SUSPENDED',
- 'FAILED',
- 'CANCELED',
+ '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' => [
- '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',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '客户之声预测',
+ 'summary' => '针对指定文章,预测用户之声。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"HotTopicVersion\\": \\"热点话题版本号标识\\",\\n \\"Status\\": \\"RUNNING\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取自定义播报单任务结果',
- ],
- 'ExportAnalysisTagDetailByTaskId' => [
- 'summary' => '导出企业VOC分析任务明细列表。',
- 'path' => '',
- 'methods' => [
- 'post',
- 'get',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunCommentGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true,\\n \\"Header\\": {\\n \\"Event\\": \\"result-generated\\\\n\\",\\n \\"EventInfo\\": \\"可空\\\\n\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0bd58ea2-dc38-45da-ac02-17f05cb9040b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"评论内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 2,\\n \\"TotalTokens\\": 3\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunContinueContent' => [
+ 'path' => '/quanmiao/aimiaobi/runContinueContent',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '业务空间id', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'Categories',
+ 'name' => 'Content',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '分类筛选列表',
- 'description' => '分类筛选列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '分类筛选',
- 'description' => '分类筛选',
- 'type' => 'string',
- 'required' => false,
- 'example' => '分类1',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '需要续写的内容', 'description' => '需要续写的内容', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Data' => [
- 'title' => '临时可访问的URL(1小时过期)',
- 'description' => '临时可访问的URL(1小时过期)',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.xlsx',
- ],
- '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',
+ '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' => '模型生成事件'],
+ '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'],
+ ],
],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Payload' => [
+ 'title' => '返回结果的 payload,json 结构',
+ 'description' => '返回结果的 payload,json 结构',
+ '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' => '总oken数量', 'description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
+ ],
+ ],
],
+ 'RequestId' => ['title' => '请求唯一ID', 'description' => '请求唯一ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": \\"http://www.example.com/xxx.xlsx\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '导出标签挖掘结果',
- ],
- 'ValidateUploadTemplate' => [
- 'summary' => '校验企业VOC上传模板。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '内容续写',
+ 'summary' => '内容续写。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunContinueContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
+ ],
+ 'RunCustomHotTopicAnalysis' => [
+ 'path' => '/quanmiao/miaoce/runCustomHotTopicAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TemplateType',
+ 'name' => 'AskUser',
'in' => 'formData',
- 'schema' => [
- 'title' => '模板类型(Content:表示内容素材模板校验 PositiveSample:正面样本)',
- 'description' => '模板类型(Content:表示内容素材模板校验,PositiveSample:正面样本)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Content',
- ],
+ 'schema' => ['title' => '模型反问', 'description' => '模型反问', 'type' => 'string', 'required' => false, 'example' => '模型反问'],
],
[
- 'name' => 'FileKey',
+ 'name' => 'UserBack',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件key',
- 'description' => '文件key',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Content',
- ],
+ 'schema' => ['title' => '用户针对模型反问的输入', 'description' => '用户针对模型反问的输入', 'type' => 'string', 'required' => false, 'example' => '用户针对模型反问的输入'],
],
[
- 'name' => 'TaskType',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)',
- 'description' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lightAppSass',
- ],
+ 'schema' => ['title' => '用户输入Prompt', 'description' => '用户输入Prompt', 'type' => 'string', 'required' => true, 'example' => '用户输入Prompt'],
+ ],
+ [
+ 'name' => 'ForceAnalysisExistsTopic',
+ 'in' => 'formData',
+ 'schema' => ['title' => '针对重复的话题,是否强制分析并覆盖已有的话题分析', 'description' => '针对重复的话题,是否强制分析并覆盖已有的话题分析', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '每次请求唯一标识', 'description' => '每次请求唯一标识', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '整轮对话任务ID', 'description' => '整轮对话任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'CustomHoTTopicBaseLlmResponse',
+ 'description' => 'CustomHoTTopicBaseLlmResponse',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'Header' => [
+ 'title' => '响应头',
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
+ ],
],
- 'Data' => [
- 'title' => '模板校验结果',
- 'description' => '模板校验结果',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
- ],
- 'CommentCount' => [
- 'title' => '评论数',
- 'description' => '观点数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
+ 'Output' => [
+ 'title' => '输出',
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Articles' => [
+ 'title' => '参照文章',
+ 'description' => '参照文章',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'a2103fcfbd5441f1991c72f8834833e3'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-08-27 14:50:47'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
+ ],
+ ],
+ ],
+ 'AskUser' => [
+ 'title' => '反问列表',
+ 'description' => '反问列表',
+ 'type' => 'array',
+ 'items' => ['description' => '模型反问', 'type' => 'string', 'example' => 'xxx'],
+ ],
+ 'AsyncTaskId' => ['title' => '异步任务ID', 'description' => '异步任务ID', 'type' => 'string', 'example' => '异步任务ID'],
+ 'Attitude' => ['title' => '自定义选题视角', 'description' => '自定义选题视角', 'type' => 'string', 'example' => '自定义选题视角'],
+ 'SearchQuery' => ['title' => 'query改写结果', 'description' => 'query改写结果', 'type' => 'string', 'example' => '大模型改变世界'],
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
+ 'TopicId' => ['title' => '话题ID', 'description' => '话题ID', 'type' => 'string', 'example' => '话题ID'],
+ ],
],
- 'DialogueCount' => [
- 'title' => '对话数量',
- 'description' => '对话数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '50',
+ 'Usage' => [
+ 'description' => 'token使用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '60'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '13'],
+ 'TotalTokens' => ['description' => '总token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '73'],
+ ],
],
],
],
- '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',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"CommentCount\\": 50,\\n \\"DialogueCount\\": 50\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '校验VOC上传模板',
- ],
- 'SubmitEnterpriseVocAnalysisTask' => [
- 'summary' => '提交VOC异步任务。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '自定义热点话题分析',
+ 'summary' => '自定义热点话题分析。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunCustomHotTopicAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"a2103fcfbd5441f1991c72f8834833e3\\",\\n \\"PubTime\\": \\"2024-08-27 14:50:47\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"AskUser\\": [\\n \\"xxx\\"\\n ],\\n \\"AsyncTaskId\\": \\"异步任务ID\\",\\n \\"Attitude\\": \\"自定义选题视角\\",\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\",\\n \\"TopicId\\": \\"话题ID\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 60,\\n \\"OutputTokens\\": 13,\\n \\"TotalTokens\\": 73\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
+ ],
+ 'RunCustomHotTopicViewPointAnalysis' => [
+ 'path' => '/quanmiao/miaoce/runCustomHotTopicViewPointAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'FileKey',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文件FileKey',
- 'description' => '文件FileKey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/bucket-name/materialDocument/tenant_agent/fileName',
- ],
- ],
- [
- 'name' => 'MaterialType',
+ 'name' => 'AskUser',
'in' => 'formData',
- 'schema' => [
- 'title' => '素材类型(shortContent: 长短评论、或工单,dialogue: 对话)',
- 'description' => '素材类型(shortContent:长短评论、或工单,dialogue:对话)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'shortContent',
- ],
+ 'schema' => ['title' => '模型反问', 'description' => '模型反问', 'type' => 'string', 'required' => false, 'example' => '模型反问'],
],
[
- 'name' => 'ModelId',
+ 'name' => 'UserBack',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型ID',
- 'description' => '模型ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'qwen-max',
- ],
+ 'schema' => ['title' => '用户反馈', 'description' => '用户反馈', 'type' => 'string', 'required' => false, 'example' => '用户反馈'],
],
[
- 'name' => 'ContentTags',
+ 'name' => 'SearchQuery',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '内容标签',
- 'description' => '内容标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '内容标签对象',
- 'type' => 'object',
- 'properties' => [
- 'TagName' => [
- 'title' => '标签名称',
- 'description' => '标签名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '一级标签-二级标签',
- ],
- 'TagValueDefinePrompt' => [
- 'title' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)',
- 'description' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '是,否',
- ],
- 'TagDefinePrompt' => [
- 'title' => '标签定义',
- 'description' => '标签定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => '一级标签-二级标签',
- ],
- 'TagTaskType' => [
- 'title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview, 筛选:filter))',
- 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview,筛选:filter)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'singleTagValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '改写后的Query', 'description' => '改写后的Query', 'type' => 'string', 'required' => false, 'example' => '改写后的Query'],
],
[
- 'name' => 'FilterTags',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '过滤标签',
- 'description' => '过滤标签列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '过滤标签对象',
- 'type' => 'object',
- 'properties' => [
- 'TagName' => [
- 'title' => '标签名称',
- 'description' => '标签名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '一级标签-二级标签',
- ],
- 'TagValueDefinePrompt' => [
- 'title' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)',
- 'description' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '是,否'."\n",
- ],
- 'TagDefinePrompt' => [
- 'title' => '标签定义',
- 'description' => '标签定义',
- 'type' => 'string',
- 'required' => false,
- 'example' => '一级标签-二级标签',
- ],
- 'TagType' => [
- 'title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview, 筛选:filter))',
- 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview,筛选:filter)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'singleTagValue',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '自定义选题视角的Prompt', 'description' => '自定义选题视角的Prompt', 'type' => 'string', 'required' => true, 'example' => '自定义选题视角的Prompt'],
],
[
- 'name' => 'PositiveSample',
+ 'name' => 'SkipAskUser',
'in' => 'formData',
- 'schema' => [
- 'title' => '正面样本内容',
- 'description' => '正面样本内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '正面样本',
- ],
+ 'schema' => ['title' => '是否跳过反问', 'description' => '是否跳过反问', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'PositiveSampleFileKey',
+ 'name' => 'TopicId',
'in' => 'formData',
- 'schema' => [
- 'title' => '正面样本文件FileKey',
- 'description' => '正面样本文件FileKey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/bucket-name/path/xxx.xlsx',
- ],
+ 'schema' => ['title' => '热点主题ID', 'description' => '热点主题ID', 'type' => 'string', 'required' => false, 'example' => '热点主题ID'],
],
[
- 'name' => 'TaskType',
+ 'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)',
- 'description' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'lightAppSass',
- ],
+ 'schema' => ['title' => '热点主题', 'description' => '热点主题', 'type' => 'string', 'required' => false, 'example' => '热点主题'],
],
[
- 'name' => 'Contents',
+ 'name' => 'TopicVersion',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '待挖掘的素材内容列表',
- 'description' => '待挖掘的素材内容列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '待挖掘的素材内容对象',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'title' => '待挖掘的素材',
- 'description' => '待挖掘的素材',
- 'type' => 'string',
- 'required' => false,
- 'example' => '内容文本',
- ],
- 'ExtraInfo' => [
- 'title' => '额外补充信息,直接给到大模型',
- 'description' => '额外补充信息,直接给到大模型',
- 'type' => 'string',
- 'required' => false,
- 'example' => '额外信息',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '热点主题版本', 'description' => '热点主题版本', 'type' => 'string', 'required' => false, 'example' => '热点主题版本'],
],
[
- 'name' => 'ApiKey',
+ 'name' => 'TopicSource',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼APIKEY',
- '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-sdfs2-wewerwe-ere',
- ],
+ 'schema' => ['title' => '热点主题来源', 'description' => '热点主题来源', 'type' => 'string', 'required' => false, 'example' => '热点主题来源'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'CustomHoTTopicBaseLlmResponse',
+ 'description' => 'CustomHoTTopicBaseLlmResponse',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'Header' => [
+ 'title' => '响应头',
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
+ ],
],
- 'Data' => [
- 'title' => '模板校验结果',
- 'description' => '模板校验结果',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'xxxxx',
+ 'Output' => [
+ 'title' => '输出',
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'AskUser' => [
+ 'title' => '反问列表',
+ 'description' => '反问列表',
+ 'type' => 'array',
+ 'items' => ['description' => '模型反问', 'type' => 'string', 'example' => 'xxxxxxx'],
+ ],
+ 'AsyncTaskId' => ['title' => '异步任务ID', 'description' => '异步任务ID', 'type' => 'string', 'example' => '异步任务ID'],
+ 'Attitude' => ['title' => '模型生成的自定义选题视角的观点', 'description' => '模型生成的自定义选题视角的观点', 'type' => 'string', 'example' => '模型生成的自定义选题视角的观点'],
+ 'CustomViewPointId' => ['description' => '自定义视角ID', 'type' => 'string', 'example' => 'xxxxxx'],
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
+ 'TopicId' => ['title' => '话题ID', 'description' => '话题ID', 'type' => 'string', 'example' => '话题ID'],
+ 'Articles' => [
+ 'title' => '参考文章列表',
+ 'description' => '参考文章列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '参考文章对象',
+ 'description' => '参考文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'."\n"
+ ."\n"],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-09-10 14:17:53'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '央视网'],
+ 'Url' => ['title' => 'URL标题', 'description' => 'URL标题', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => '文章摘要'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'Usage' => [
+ 'description' => '镜像是否已经运行在ECS实例中。取值范围:'."\n"
+ ."\n"
+ .'- instance:镜像处于运行状态,有ECS实例使用。'."\n"
+ .'- none:镜像处于闲置状态,暂无ECS实例使用。',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '51'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '79'],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '130'],
+ ],
],
],
],
- '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',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxxx\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交企业VOC分析任务',
- ],
- 'ListAnalysisTagDetailByTaskId' => [
- 'summary' => '分页获取企业VOC分析任务明细列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '自定义选题视角分析',
+ 'summary' => '自定义选题视角分析。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-13T10:07:25.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunCustomHotTopicViewPointAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"AskUser\\": [\\n \\"xxxxxxx\\"\\n ],\\n \\"AsyncTaskId\\": \\"异步任务ID\\",\\n \\"Attitude\\": \\"模型生成的自定义选题视角的观点\\",\\n \\"CustomViewPointId\\": \\"xxxxxx\\",\\n \\"Text\\": \\"文本生成结果\\",\\n \\"TopicId\\": \\"话题ID\\",\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\\\n\\\\n\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"PubTime\\": \\"2024-09-10 14:17:53\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\",\\n \\"Summary\\": \\"文章摘要\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 51,\\n \\"OutputTokens\\": 79,\\n \\"TotalTokens\\": 130\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
+ ],
+ 'RunDeepWriting' => [
+ 'path' => '/pop/deepWrite/runDeepWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-ir8zkqry2fncaxwq'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '任务ID', 'type' => 'string', 'required' => false, 'example' => '95c2fbe6-5a20-4fc2-8a93-376ed05fbe13'],
],
[
- 'name' => 'Categories',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '分类筛选列表',
- 'description' => '分类筛选列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '分类筛选',
- 'description' => '分类筛选',
- 'type' => 'string',
- 'required' => false,
- 'example' => '分类1',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'NextToken',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '下一页标识',
- 'description' => '下一页标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'token-xxxx',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '每页最大数量',
- 'description' => '每页最大数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'Size',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '请求记录数',
- 'description' => '请求记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
- ],
- [
- 'name' => 'Current',
+ 'name' => 'Cursor',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '游标。流式事件的序号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => '403'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => '错误消息'],
+ 'Event' => [
+ 'description' => 'SSE事件。',
+ 'type' => 'string',
+ 'enumValueTitles' => ['response.sub_task.created' => '子任务已创建', 'response.output_item.done' => '中间结果输出完成', 'response.completed' => '任务完成', 'response.created' => '任务已创建'],
+ 'example' => 'response.output_item.done',
+ ],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => 'c2e2e991-f96a-4fcc-9ff7-d0df46c6d232'],
+ 'StatusCode' => ['description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'b84d31a5-44b2-4a35-9c6d-878d459c93d0'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => 'FAB10D42-F081-557B-8DCB-D6FB7AAF100B'],
+ ],
],
- 'Data' => [
- 'title' => '标签挖掘分类明细列表',
- 'description' => '标签挖掘分类明细列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签挖掘分类明细',
- 'description' => '标签挖掘分类明细',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '数据主键ID',
- 'description' => '数据主键ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '112',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'TagTaskType' => [
- 'title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)',
- 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)',
- 'type' => 'string',
- 'example' => 'summaryAndOverview',
- ],
- 'Content' => [
- 'title' => '标签内容',
- 'description' => '标签内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'ContentTags' => [
- 'title' => '标签内容列表',
- 'description' => '标签内容列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '标签值列表',
- 'description' => '标签值列表',
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => '类型', 'type' => 'string', 'example' => '同上级Event'],
+ 'SequenceNumber' => ['description' => '流式事件的序号', 'type' => 'string', 'example' => '1'],
+ 'OutputIndex' => ['description' => '本次事件新加的输出item的序号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Response' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'TagName' => [
- 'title' => '标签名称',
- 'description' => '标签名称',
+ 'Id' => ['description' => '本次任务的唯一标识', 'type' => 'string', 'example' => 'b2dc224b38694e0b668020159a7c5732'],
+ 'Status' => [
+ 'description' => '本次任务的执行状态',
'type' => 'string',
- 'example' => 'xxx',
+ 'enumValueTitles' => ['in_progress' => '处理中', 'completed' => '已完成'],
+ 'example' => 'in_progress',
],
- 'SummaryOverview' => [
- 'title' => '总结概括',
- 'description' => '总结概括',
+ ],
+ ],
+ 'Item' => [
+ 'description' => '本次事件新加的输出item',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['description' => 'item的唯一标识', 'type' => 'string', 'example' => '88f6ed9e85c4f9377378da23e6a370d1'],
+ 'Status' => [
+ 'description' => 'item的状态',
'type' => 'string',
- 'example' => 'xxx',
+ 'enumValueTitles' => ['in_progress' => 'in_progress', 'completed' => 'completed'],
+ 'example' => 'completed',
],
- 'Tags' => [
- 'title' => '标签值列表',
- 'description' => '标签值列表',
+ 'Type' => [
+ 'description' => 'item的类型',
+ 'type' => 'string',
+ 'enumValueTitles' => ['function_call' => 'function_call', 'message' => 'message'],
+ 'example' => 'function_call',
+ ],
+ 'Arguments' => ['description' => '参数', 'type' => 'string', 'example' => 'item类型为function_call时,此字段有值,为调用函数的入参'],
+ 'Name' => ['description' => '参数名称', 'type' => 'string', 'example' => 'item类型为function_call时,此字段有值,为调用的函数名字'],
+ 'Result' => ['description' => 'item的结果', 'type' => 'string', 'example' => 'item类型为function_call时,此字段有值,为调用的函数的输出'],
+ 'Agent' => ['description' => '输出此item的agent名字', 'type' => 'string', 'example' => 'ProjectManager'],
+ 'Content' => [
+ 'description' => 'item类型为message时,此字段有值,是输出content的列表',
'type' => 'array',
'items' => [
- 'title' => '标签值',
- 'description' => '标签值',
- 'type' => 'string',
- 'example' => '标签值列表',
+ 'description' => '文本内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['description' => 'item类型为message时,此字段的值是output_text', 'type' => 'string', 'example' => 'output_text'],
+ 'Text' => ['description' => 'item类型为message时, 输出的文本内容', 'type' => 'string', 'example' => '<TASK_DONE>'],
+ ],
],
],
],
@@ -28500,2268 +18893,1089 @@
],
],
],
- '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',
- ],
- 'NextToken' => [
- 'title' => '下一页标识',
- 'description' => '下一页标识',
- 'type' => 'string',
- 'example' => 'token-xxxx',
- ],
- 'MaxResults' => [
- 'title' => '每页最大数量',
- 'description' => '每页最大数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
+ 'RequestId' => ['description' => '唯一请求ID', 'type' => 'string', 'example' => '31AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3'],
+ 'HttpStatusCode' => ['description' => 'Http状态码', 'type' => 'string', 'example' => '200'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": [\\n {\\n \\"Id\\": 112,\\n \\"TaskId\\": \\"xxx\\",\\n \\"TagTaskType\\": \\"summaryAndOverview\\",\\n \\"Content\\": \\"xxx\\",\\n \\"ContentTags\\": [\\n {\\n \\"TagName\\": \\"xxx\\",\\n \\"SummaryOverview\\": \\"xxx\\",\\n \\"Tags\\": [\\n \\"标签值列表\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"NextToken\\": \\"token-xxxx\\",\\n \\"MaxResults\\": 10,\\n \\"TotalCount\\": 10\\n}","type":"json"}]',
- 'title' => '根据任务ID获取标签分析明细列表',
- ],
- 'GetEnterpriseVocAnalysisTask' => [
- 'summary' => '获取企业VOC分析任务结果。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '查询深度写作事件',
+ 'summary' => '查询深度写作事件。'."\n"
+ .'系统以SSE事件的形式下发任务执行过程中的详细信息。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDeepWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"错误消息\\",\\n \\"Event\\": \\"response.output_item.done\\",\\n \\"SessionId\\": \\"c2e2e991-f96a-4fcc-9ff7-d0df46c6d232\\",\\n \\"StatusCode\\": 200,\\n \\"TaskId\\": \\"b84d31a5-44b2-4a35-9c6d-878d459c93d0\\",\\n \\"TraceId\\": \\"FAB10D42-F081-557B-8DCB-D6FB7AAF100B\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Type\\": \\"同上级Event\\",\\n \\"SequenceNumber\\": \\"1\\",\\n \\"OutputIndex\\": 1,\\n \\"Response\\": {\\n \\"Id\\": \\"b2dc224b38694e0b668020159a7c5732\\",\\n \\"Status\\": \\"in_progress\\"\\n },\\n \\"Item\\": {\\n \\"Id\\": \\"88f6ed9e85c4f9377378da23e6a370d1\\",\\n \\"Status\\": \\"completed\\",\\n \\"Type\\": \\"function_call\\",\\n \\"Arguments\\": \\"item类型为function_call时,此字段有值,为调用函数的入参\\",\\n \\"Name\\": \\"item类型为function_call时,此字段有值,为调用的函数名字\\",\\n \\"Result\\": \\"item类型为function_call时,此字段有值,为调用的函数的输出\\",\\n \\"Agent\\": \\"ProjectManager\\",\\n \\"Content\\": [\\n {\\n \\"Type\\": \\"output_text\\",\\n \\"Text\\": \\"<TASK_DONE>\\"\\n }\\n ]\\n }\\n }\\n },\\n \\"RequestId\\": \\"31AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'RunDocBrainmap' => [
+ 'path' => '/miaodu/stream/runDocBrainmap',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '会话ID', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
+ [
+ 'name' => 'DocId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '脑图自定义prompt要求', 'type' => 'string', 'required' => false, 'example' => '请按英文输出'],
+ ],
+ [
+ 'name' => 'CleanCache',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否清理掉之前的缓存', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'NodeNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => '第二级有几个节点', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'WordNumber',
+ 'in' => 'formData',
+ 'schema' => ['description' => '节点文字的个数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'referenceContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要生成脑图的内容,优先级高于docId', 'type' => 'string', 'required' => false, 'example' => '要生成脑图的内容'],
+ ],
+ [
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
+ ],
+ [
+ 'name' => 'ResponseFormat',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '0'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'task-failed'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '07181f55-2311-48af-8048-132a77dee020'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '161816'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '6427cdf4-2ffe-4d05-b0ef-c4adceea90f4'],
+ ],
],
- 'Data' => [
- 'title' => '企业VOC分析结果',
- 'description' => '企业VOC分析结果',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'StatisticsOverview' => [
- 'title' => '统计概览',
- 'description' => '统计概览',
+ 'Output' => [
+ 'description' => '输出',
'type' => 'object',
'properties' => [
- 'Count' => [
- 'title' => '总分析数据条数',
- 'description' => '总分析数据条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TagDimensionStatistics' => [
- 'title' => '内容标签统计',
- 'description' => '内容标签统计',
- 'type' => 'object',
- 'properties' => [
- 'TagValueCountStatistic' => [
- 'title' => '标签值数量统计',
- 'description' => '标签值数量统计',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TagName' => [
- 'title' => '标签名称',
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'TagTaskType' => [
- 'title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)',
- 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)',
- 'type' => 'string',
- 'example' => 'multiTagValues',
- ],
- 'ValueCount' => [
- 'title' => '标签值数量',
- 'description' => '标签值数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- ],
- ],
- ],
- 'FilterDimensionStatistics' => [
- 'title' => '筛选标签统计',
- 'description' => '筛选标签统计',
- 'type' => 'object',
- 'properties' => [
- 'TagValueCountStatistic' => [
- 'title' => '标签值数量统计',
- 'description' => '标签值数量统计',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'TagName' => [
- 'title' => '标签名称',
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'TagTaskType' => [
- 'title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)',
- 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview)',
- 'type' => 'string',
- 'example' => 'multiTagValues',
- ],
- 'ValueCount' => [
- 'title' => '标签值数量',
- 'description' => '标签值数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- ],
- ],
- ],
- ],
- ],
+ 'Content' => ['description' => '脑图json内容', 'type' => 'string', 'example' => '{"xxxx":"xxx"}'],
],
],
'Usage' => [
- 'title' => '消耗量统计',
- 'description' => '消耗量统计',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'OutputTokens' => [
- 'title' => '输出token数',
- 'description' => '输出token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'InputTokens' => [
- 'title' => '输入token数',
- 'description' => '输入token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '65'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '165'],
],
],
- 'Status' => [
- 'title' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'description' => '任务状态(PENDING:待执行,RUNNING:执行中,SUCCESSED:成功,FAILED:失败,CANCELED:已取消)',
- 'type' => 'string',
- 'example' => 'SUCCESSED',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'error',
- ],
],
],
- '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',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"StatisticsOverview\\": {\\n \\"Count\\": 100,\\n \\"TagDimensionStatistics\\": {\\n \\"TagValueCountStatistic\\": [\\n {\\n \\"TagName\\": \\"xxx\\",\\n \\"TagTaskType\\": \\"multiTagValues\\",\\n \\"ValueCount\\": 100\\n }\\n ]\\n },\\n \\"FilterDimensionStatistics\\": {\\n \\"TagValueCountStatistic\\": [\\n {\\n \\"TagName\\": \\"xxx\\",\\n \\"TagTaskType\\": \\"multiTagValues\\",\\n \\"ValueCount\\": 100\\n }\\n ]\\n }\\n },\\n \\"Usage\\": {\\n \\"OutputTokens\\": 100,\\n \\"InputTokens\\": 200\\n },\\n \\"Status\\": \\"SUCCESSED\\",\\n \\"ErrorMessage\\": \\"error\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取企业VOC挖掘任务结果',
- ],
- 'GetCategoriesByTaskId' => [
- 'summary' => '获取某次标签挖掘结果分类。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => '全文脑图',
+ 'summary' => '针对文章或者书,生成三级脑图,且支持生成多语种,支持控制脑图第二级数量,支持控制叶子节点的字数。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-17T03:26:54.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocBrainmap',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"07181f55-2311-48af-8048-132a77dee020\\",\\n \\"TaskId\\": \\"161816\\",\\n \\"TraceId\\": \\"6427cdf4-2ffe-4d05-b0ef-c4adceea90f4\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"{\\\\\\"xxxx\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 65,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 165\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n}","type":"json"}]',
+ ],
+ 'RunDocIntroduction' => [
+ 'summary' => '针对一篇文章、视频或者URL,生成文章的导读内容,包含全文总结、关键要点、章节速览(即分段、每段的总结、段落摘要)。此外支持多种多语言的输入和输出。如果用户仅需要对文章进行全文总结,可使用RunDocSummary接口实现,具体请参见https://help.aliyun.com/zh/model-studio/api-aimiaobi-2023-08-01-rundocsummary。',
+ 'path' => '/miaodu/stream/runDocIntroduction',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
- 'chargeType' => 'free',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务唯一ID'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => 'a3b5eb35-6b28-4cf9-ac09-1dec25ab4df6'],
+ ],
+ [
+ 'name' => 'SummaryPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '总结内容自定义要求', 'type' => 'string', 'required' => false, 'example' => '用英文输出'],
+ ],
+ [
+ 'name' => 'KeyPointPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '关键点自定义要求', 'type' => 'string', 'required' => false, 'example' => '用英文输出'],
+ ],
+ [
+ 'name' => 'IntroductionPrompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '导读内容自定义要求', 'type' => 'string', 'required' => false, 'example' => '用英文输出'],
+ ],
+ [
+ 'name' => 'CleanCache',
+ 'in' => 'formData',
+ 'schema' => ['description' => '清除缓存', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'referenceContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要进行导读的内容,如果不为空,该值优先于docId', 'type' => 'string', 'required' => false, 'example' => '要进行导读的内容'],
+ ],
+ [
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => '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',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'task-started'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '20247a52-23e2-46fb-943d-309cdee2bc6d'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '8a9cecb7-6d20-32db-8823-5882c217b647'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0bd58ea2-dc38-45da-ac02-17f05cb9040b'],
+ ],
],
- 'Data' => [
- 'description' => '分类对象列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '分类对象',
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'description' => '分类名称',
- 'type' => 'string',
- 'example' => '类别1',
- ],
- 'Children' => [
- 'description' => '子分类列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '子分类对象',
- 'type' => 'object',
- 'properties' => [
- 'Category' => [
- 'description' => '子分类名称',
- 'type' => 'string',
- 'example' => '类别1-1',
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Introductions' => [
+ 'description' => '分段导读内容数组',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Blocks' => [
+ 'description' => '位置信息数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '位置信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Height' => ['description' => '文本块高', 'type' => 'integer', 'format' => 'int32', 'example' => '600'],
+ 'PageId' => ['description' => '文本块所在页号', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Width' => ['description' => '文本块宽', 'type' => 'integer', 'format' => 'int32', 'example' => '600'],
+ 'X' => ['description' => '块左上角X坐标', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Y' => ['description' => '块左上角Y坐标', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'BeginTime' => ['description' => '段落开始时间', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'EndTime' => ['description' => '段落结束时间', 'type' => 'integer', 'format' => 'int64', 'example' => '1200'],
+ ],
+ ],
+ ],
+ 'StartPageId' => ['description' => '多个文本块的起始页号', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Summary' => ['description' => '本段摘要', 'type' => 'string', 'example' => '本段摘要内容'],
+ 'Title' => ['description' => '本段标题', 'type' => 'string', 'example' => '本段标题内容'],
],
+ 'description' => '',
],
],
+ 'KeyPoint' => ['description' => '要点内容', 'type' => 'string', 'example' => '要点1;要点2;'],
+ 'Summary' => ['description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要内容'],
],
- 'Count' => [
- 'title' => '该分类下对应的VOC数量',
- 'description' => '该分类下对应的VOC数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ ],
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
],
],
],
],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => 'C9B5BEA6-E8C4-5861-BE37-D906D516510E'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- '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 {\\n \\"Category\\": \\"类别1\\",\\n \\"Children\\": [\\n {\\n \\"Category\\": \\"类别1-1\\"\\n }\\n ],\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '根据任务ID获取分类列表',
- ],
- 'CreateDataset' => [
- 'summary' => '数据源管理-创建。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '文档导读',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-04-17T03:26:54.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocIntroduction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"20247a52-23e2-46fb-943d-309cdee2bc6d\\",\\n \\"TaskId\\": \\"8a9cecb7-6d20-32db-8823-5882c217b647\\",\\n \\"TraceId\\": \\"0bd58ea2-dc38-45da-ac02-17f05cb9040b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Introductions\\": [\\n {\\n \\"Blocks\\": [\\n {\\n \\"Height\\": 600,\\n \\"PageId\\": 10,\\n \\"Width\\": 600,\\n \\"X\\": 10,\\n \\"Y\\": 10,\\n \\"BeginTime\\": 0,\\n \\"EndTime\\": 1200\\n }\\n ],\\n \\"StartPageId\\": 10,\\n \\"Summary\\": \\"本段摘要内容\\",\\n \\"Title\\": \\"本段标题内容\\"\\n }\\n ],\\n \\"KeyPoint\\": \\"要点1;要点2;\\",\\n \\"Summary\\": \\"大纲摘要内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"C9B5BEA6-E8C4-5861-BE37-D906D516510E\\"\\n}","type":"json"}]',
+ ],
+ 'RunDocQa' => [
+ 'path' => '/miaodu/stream/runDocQA',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'get',
'riskType' => 'none',
- 'chargeType' => 'free',
+ 'chargeType' => 'paid',
+ 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'],
],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
+ 'schema' => ['description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。', 'type' => 'string', 'required' => true, 'example' => 'llm-dswd4003ny4gh9rw'],
+ ],
+ [
+ 'name' => 'SearchSource',
+ 'in' => 'formData',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
+ 'description' => '搜索源',
'type' => 'string',
'required' => true,
- 'example' => 'llm-xxx',
+ 'enumValueTitles' => ['fromIndexLib' => '基于整个文档库进行问答', 'fromWeb' => '基于互联网搜索进行问答', 'fromRefContent' => '基于ReferenceContent字段进行问答', 'fromDoc' => '基于给出的文档Id进行文档问答'],
+ 'example' => 'fromWeb',
],
],
[
- 'name' => 'DatasetType',
+ 'name' => 'DocIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '数据集类型',
- 'description' => '数据集类型:'."\n"
- .'- CustomSemanticSearch:自建语义索引(默认),用户上传文档构建数据集'."\n"
- .'- ThirdSearch:三方搜索源(api),配置用户自己的搜索api',
- 'type' => 'string',
+ 'description' => '多个文档Id数组',
+ 'type' => 'array',
+ 'items' => ['description' => '文档Id', 'type' => 'string', 'required' => false, 'example' => '10022'],
'required' => false,
- 'example' => 'CustomSemanticSearch',
- 'default' => 'CustomSemanticSearch',
],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称,全局唯一',
- 'description' => '数据集名称,全局唯一',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'businessDataset',
- ],
+ 'schema' => ['description' => '问题', 'type' => 'string', 'required' => true, 'example' => '苹果16手机什么时候发布'],
],
[
- 'name' => 'DatasetDescription',
+ 'name' => 'ReferenceContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '提问者主动提供的关联内容', 'type' => 'string', 'required' => false, 'example' => '关联内容'],
+ ],
+ [
+ 'name' => 'ConversationContexts',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '数据集描述',
- 'description' => '数据集描述:控制台展示名称,建议传入业务可读的名称',
- 'type' => 'string',
+ 'description' => '历史上下文内容数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '历史上下文',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '问答内容', 'type' => 'string', 'required' => false, 'example' => '问答内容'],
+ 'Role' => ['description' => '角色', 'type' => 'string', 'required' => false, 'example' => 'user'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '企业知识库',
],
],
[
- 'name' => 'SearchDatasetEnable',
+ 'name' => 'SessionId',
'in' => 'formData',
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => 'f486c4e2-b773-4d65-88f8-2ba540610456'],
+ ],
+ [
+ 'name' => 'CategoryIds',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关:'."\n"
- .'- 0:全部关闭'."\n"
- .'- 1:仅妙搜可见'."\n"
- .'- 2:仅妙笔可见'."\n"
- .'- 3:妙搜&妙笔均可见 (默认)',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '过滤目录Id数组,只在SearchSource为fromIndexLib时有效',
+ 'type' => 'array',
+ 'items' => ['description' => '类目ID', 'type' => 'string', 'required' => false, 'example' => 'default'],
'required' => false,
- 'example' => '3',
- 'default' => '3',
],
],
[
- 'name' => 'DatasetConfig',
+ 'name' => 'ModelName',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '数据集配置',
- 'description' => '数据集搜索配置',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'SearchSourceConfigs' => [
- 'title' => '三方搜索:api定义',
- 'description' => '三方搜索:api定义',
- 'type' => 'array',
- 'items' => [
- 'description' => '三方搜索:api定义',
- 'type' => 'object',
- 'properties' => [
- 'DemoQuery' => [
- 'title' => '可以搜索到的关键词,用来验证是否可用',
- 'description' => '可以搜索到的关键词,用来验证是否可用',
- 'type' => 'string',
- 'required' => false,
- 'example' => '可以搜索到的关键词,用来验证是否可用',
- ],
- 'Size' => [
- 'title' => '默认请求、响应数据条数限制',
- 'description' => '默认请求、响应数据条数限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'SearchSourceRequestConfig' => [
- 'title' => 'api请求配置',
- 'description' => 'api请求配置',
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => 'api地址',
- 'description' => 'api地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'api地址',
- ],
- 'Method' => [
- 'title' => '请求方式',
- 'description' => '请求方式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请求方式',
- ],
- 'ConnectTimeout' => [
- 'title' => '连接超时时间:单位毫秒',
- 'description' => '连接超时时间:单位毫秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3000',
- ],
- 'SocketTimeout' => [
- 'title' => '读超时时间:单位毫秒',
- 'description' => '读超时时间:单位毫秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3000',
- ],
- 'Headers' => [
- 'description' => 'http请求头',
- 'type' => 'array',
- 'items' => [
- 'description' => 'http请求头',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数名称',
- ],
- 'ValueType' => [
- 'title' => '参数值数据类型: 默认string',
- 'description' => '参数值数据类型:默认string',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值数据类型:默认string',
- ],
- 'ValueFormat' => [
- 'title' => 'valueType = time 时有效',
- 'description' => 'valueType = time 时有效',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'valueType = time 时有效',
- ],
- 'Value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件', 'type' => 'string', 'example' => 'task-started'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => 'f5517ee8-dbec-4dc8-bd0a-af084b5e3db1'],
+ 'TaskId' => ['description' => '任务id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '回答内容', 'type' => 'string', 'example' => '回答内容'],
+ 'InterveneContent' => ['description' => '干预后的回答内容', 'type' => 'string', 'example' => '干预后的回答内容'],
+ 'IsReject' => ['description' => '是否拒识', 'type' => 'boolean', 'example' => 'false'],
+ 'MediaUrlList' => [
+ 'description' => '多模态资源信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '多模态资源对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'ClipInfos' => [
+ 'description' => '相关视频时间信息数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '相关视频时间信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'From' => ['description' => '视频片段开始时间', 'type' => 'number', 'format' => 'double', 'example' => '0'],
+ 'To' => ['description' => '视频片段结束时间', 'type' => 'number', 'format' => 'double', 'example' => '30'],
+ ],
],
],
- 'required' => false,
+ 'FileUrl' => ['description' => '文件url', 'type' => 'string', 'example' => 'https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg'],
+ 'MediaType' => ['description' => '媒资媒体类型', 'type' => 'string', 'example' => 'video'],
],
- 'required' => false,
],
- 'Params' => [
- 'title' => '请求path参数',
- 'description' => '请求path参数',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数名称',
- ],
- 'ValueType' => [
- 'title' => '参数值数据类型: 默认string',
- 'description' => '参数值数据类型:默认string',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值数据类型:默认string',
- ],
- 'ValueFormat' => [
- 'title' => 'valueType = time 时有效',
- 'description' => 'valueType = time 时有效',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'valueType = time 时有效',
- ],
- 'Value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值',
- ],
- ],
- 'required' => false,
+ ],
+ 'Recommends' => [
+ 'description' => '推荐内容数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '推荐内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['description' => '推荐内容标题', 'type' => 'string', 'example' => '标题内容'],
+ 'Url' => ['description' => '推荐内容url', 'type' => 'string', 'example' => '推荐内容url'],
],
- 'required' => false,
- ],
- 'PathParamsEnable' => [
- 'title' => '是否开启pathParam',
- 'description' => '是否开启pathParam',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Body' => [
- 'title' => '请求body',
- 'description' => '请求body',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
],
],
- 'required' => false,
- ],
- 'SearchSourceResponseConfig' => [
- 'title' => 'api响应配置',
- 'description' => 'api响应配置',
- 'type' => 'object',
- 'properties' => [
- 'JqNodes' => [
- 'title' => '节点配置',
- 'description' => '节点配置',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点key',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => '节点数据类型:string number list object base',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点数据类型:string number list object base',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '节点路径',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点路径',
- ],
- 'JqNodes' => [
- 'title' => '子节点配置',
- 'description' => '子节点配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'title',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => 'type类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'string',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '路径。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点路径',
- ],
- 'JqNodes' => [
- 'description' => '子节点配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'title',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => 'type类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'string',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '节点路径',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点路径',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
+ 'References' => [
+ 'description' => '回答内容来源数组',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '回答内容来源',
+ 'type' => 'object',
+ 'properties' => [
+ 'PubTime' => ['description' => '发布时间', 'type' => 'string', 'example' => '2024-10-08 18:00'],
+ 'Source' => ['description' => '来源', 'type' => 'string', 'example' => '新浪新闻'],
+ 'SourceDocId' => ['description' => '来源docId', 'type' => 'string', 'example' => '123456'],
+ 'Title' => ['description' => '关联内容标题', 'type' => 'string', 'example' => '标题内容'],
+ 'Url' => ['description' => '文章URL', 'type' => 'string', 'example' => 'http://xxxxx'],
],
- 'required' => false,
],
],
- 'required' => false,
],
],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'SearchSourceConfig' => [
- 'description' => '数据集配置项',
- 'type' => 'object',
- 'properties' => [
- 'TagSearchEnable' => [
- 'description' => '标签是否参与搜索:默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'TagGenerateEnable' => [
- 'description' => '标签是否参与生成:默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'MetadataKeyValueSearchEnable' => [
- 'description' => 'metadata-keyValue部分是否参与搜索:默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'MetadataKeyValueGenerateEnable' => [
- 'description' => 'metadata-keyValue部分是否参与生成:默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ '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,
],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
],
- 'required' => false,
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '文档问答(文章问答/多模态文件问答)',
+ 'summary' => '文章问答:针对一个自然语言类的query,在指定的文章范围内给出文字答案(有图则会配图),并显示溯源信息。'."\n"
+ .'多模态文件问答:针对一个自然语言类的query,在指定的多模态文件范围内给出文字答案,并带上相关的图片、视频片段或者文字,并显示溯源信息。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'DocumentHandleConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '数据集索引配置',
- 'description' => '数据集索引配置',
- 'type' => 'object',
- 'properties' => [
- 'DisableHandleMultimodalMedia' => [
- 'title' => '禁用多媒体文件处理逻辑,默认为false',
- 'description' => '禁用多媒体文件处理逻辑:'."\n"
- .'- true:禁用多模态(图片、视频)索引,仅索引和搜索文本'."\n"
- .'- false:支持多模态(文本、图片、视频)索引,同时开通视频云并在系统管理中做了授权才正式生效,仅设置false,这里识别到未授权会自动跳过图片、视频索引(默认)',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocQa',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"f5517ee8-dbec-4dc8-bd0a-af084b5e3db1\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"46e5c2b5-0877-4f09-bd91-ab0cf314e48b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"回答内容\\",\\n \\"InterveneContent\\": \\"干预后的回答内容\\",\\n \\"IsReject\\": false,\\n \\"MediaUrlList\\": [\\n {\\n \\"ClipInfos\\": [\\n {\\n \\"From\\": 0,\\n \\"To\\": 30\\n }\\n ],\\n \\"FileUrl\\": \\"https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg\\",\\n \\"MediaType\\": \\"video\\"\\n }\\n ],\\n \\"Recommends\\": [\\n {\\n \\"Title\\": \\"标题内容\\",\\n \\"Url\\": \\"推荐内容url\\"\\n }\\n ],\\n \\"References\\": [\\n {\\n \\"PubTime\\": \\"2024-10-08 18:00\\",\\n \\"Source\\": \\"新浪新闻\\",\\n \\"SourceDocId\\": \\"123456\\",\\n \\"Title\\": \\"标题内容\\",\\n \\"Url\\": \\"http://xxxxx\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n}","type":"json"}]',
+ ],
+ 'RunDocSmartCard' => [
+ 'summary' => '针对划选的文字或指定chat,自动打标并生成一个卡片笔记。',
+ 'path' => '/miaodu/stream/runDocSmartCard',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
+ 'security' => [
[
- 'name' => 'InvokeType',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
+ 'parameters' => [
+ [
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '调用方式:目前仅支持值portal,标识控制台调用。'."\n"
- .'- 空时:当DatasetType= ThirdSearch,datasetConfig.SearchSourceConfigs(三方api定义)必传。'."\n"
- .'- portal时:当DatasetType= ThirdSearch,后台会默认初始化一个SearchSourceConfigs(三方apidemo)示例,供参考。',
- 'description' => '调用方式:目前仅支持值portal,标识控制台调用。'."\n"
- .'- 空时:当DatasetType= ThirdSearch,datasetConfig.SearchSourceConfigs(三方api定义)必传。'."\n"
- .'- portal时:当DatasetType= ThirdSearch,后台会默认初始化一个SearchSourceConfigs(三方apidemo)示例,供参考。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'portal',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
+ ],
+ [
+ 'name' => 'DocId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => true, 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55'],
+ ],
+ [
+ 'name' => 'SessionId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '提示词', 'type' => 'string', 'required' => false, 'example' => '自定义提示词'],
+ ],
+ [
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'DatasetId' => [
- 'title' => '数据集ID',
- 'description' => '数据集ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时回见',
- 'type' => 'string',
- 'example' => '2024-11-12 21:46:24',
- ],
- 'DatasetType' => [
- 'title' => '数据集类型',
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'CustomSemanticSearch',
- ],
- 'DatasetName' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DatasetDescription' => [
- 'title' => '数据集显示名称',
- 'description' => '数据集显示名称',
- 'type' => 'string',
- 'example' => 'xxx',
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'finished'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '通话唯一ID', 'type' => 'string', 'example' => '07181f55-2311-48af-8048-132a77dee020'],
+ 'TaskId' => ['description' => '任务ID。', 'type' => 'string', 'example' => '8d55b429d7c6d321fcff54823e8d317b'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0abb781c17337107444473701ed7c3'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '卡片标题', 'type' => 'string', 'example' => '标题内容'],
+ 'Tags' => [
+ 'description' => '卡片标签数组',
+ 'type' => 'array',
+ 'items' => ['description' => '卡片标签', 'type' => 'string', 'example' => '标签内容'],
+ ],
+ ],
],
- 'SearchDatasetEnable' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
+ ],
],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-创建',
- ],
- 'GetDataset' => [
- 'summary' => '数据源管理-详情。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '文档智能卡片',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocSmartCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"07181f55-2311-48af-8048-132a77dee020\\",\\n \\"TaskId\\": \\"8d55b429d7c6d321fcff54823e8d317b\\",\\n \\"TraceId\\": \\"0abb781c17337107444473701ed7c3\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"标题内容\\",\\n \\"Tags\\": [\\n \\"标签内容\\"\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 101\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunDocSummary' => [
+ 'path' => '/miaodu/stream/runDocSummary',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称,全局唯一',
- 'description' => '数据集名称,全局唯一',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'businessDataset',
- 'maxLength' => 30,
- 'minLength' => 3,
- ],
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => '0f56f98a-f2d8-47ec-98e9-1cbdcffa9539'],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集id',
- 'description' => '数据集id:和DatasetName二选一必选',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => '12345'],
+ ],
+ [
+ 'name' => 'Query',
+ 'in' => 'formData',
+ 'schema' => ['description' => '自定义要求', 'type' => 'string', 'required' => false, 'example' => '请总结一下这篇文档'],
+ ],
+ [
+ 'name' => 'RecommendContent',
+ 'in' => 'formData',
+ 'schema' => ['description' => '要总结的内容', 'type' => 'string', 'required' => false, 'example' => '要总结的内容'],
+ ],
+ [
+ 'name' => 'CleanCache',
+ 'in' => 'formData',
+ 'schema' => ['description' => '清除当前缓存', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'DatasetId' => [
- 'title' => '数据集ID',
- 'description' => '数据集ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-12 21:46:24',
- ],
- 'DatasetType' => [
- 'title' => '数据集类型',
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'CustomSemanticSearch',
- ],
- 'DatasetName' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DatasetConfig' => [
- 'description' => '数据集搜索配置',
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'task-started'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'b057f2fa-2277-477b-babf-cbc062307828'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
'type' => 'object',
'properties' => [
- 'SearchSourceConfigs' => [
- 'title' => '三方搜索:api定义',
- 'description' => '三方搜索:api定义',
- 'type' => 'array',
- 'items' => [
- 'description' => '三方搜索:api定义',
- 'type' => 'object',
- 'properties' => [
- 'DemoQuery' => [
- 'title' => '可以搜索到的关键词,用来验证是否可用',
- 'description' => '可以搜索到的关键词,用来验证是否可用',
- 'type' => 'string',
- 'example' => '可以搜索到的关键词,用来验证是否可用',
- ],
- 'Size' => [
- 'title' => '默认请求、响应数据条数限制',
- 'description' => '默认请求、响应数据条数限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'SearchSourceRequestConfig' => [
- 'title' => 'api请求配置',
- 'description' => 'api请求配置',
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => 'api地址',
- 'description' => 'api地址',
- 'type' => 'string',
- 'example' => 'api地址',
- ],
- 'Method' => [
- 'title' => '请求方式',
- 'description' => '请求方式',
- 'type' => 'string',
- 'example' => '请求方式',
- ],
- 'ConnectTimeout' => [
- 'title' => '连接超时时间:单位毫秒',
- 'description' => '连接超时时间',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '30',
- ],
- 'SocketTimeout' => [
- 'title' => '读超时时间:单位毫秒',
- 'description' => '读超时时间',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '78',
- ],
- 'Headers' => [
- 'description' => 'http请求头',
- 'type' => 'array',
- 'items' => [
- 'description' => 'http请求头',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'example' => '参数名称',
- ],
- 'ValueType' => [
- 'title' => '参数值数据类型: 默认string',
- 'description' => '参数值数据类型:默认string',
- 'type' => 'string',
- 'example' => '参数值数据类型:默认string',
- ],
- 'ValueFormat' => [
- 'title' => 'valueType = time 时有效',
- 'description' => 'valueType = time 时有效',
- 'type' => 'string',
- 'example' => 'valueType = time 时有效',
- ],
- 'Value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'example' => '参数值',
- ],
- ],
- ],
- ],
- 'Params' => [
- 'title' => '请求path参数',
- 'description' => '请求path参数',
- 'type' => 'array',
- 'items' => [
- 'description' => '请求path参数',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'example' => '参数名称',
- ],
- 'ValueType' => [
- 'title' => '参数值数据类型: 默认string',
- 'description' => '参数值数据类型:默认string',
- 'type' => 'string',
- 'example' => '参数值数据类型:默认string',
- ],
- 'ValueFormat' => [
- 'title' => 'valueType = time 时有效',
- 'description' => 'valueType = time 时有效',
- 'type' => 'string',
- 'example' => 'valueType = time 时有效',
- ],
- 'Value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'example' => '参数值',
- ],
- ],
- ],
- ],
- 'PathParamsEnable' => [
- 'title' => '是否开启pathParam',
- 'description' => '是否开启pathParam',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Body' => [
- 'title' => '请求body',
- 'description' => '请求body',
- 'type' => 'string',
- 'example' => '请求body',
- ],
- ],
- ],
- 'SearchSourceResponseConfig' => [
- 'title' => 'api响应配置',
- 'description' => 'api响应配置',
- 'type' => 'object',
- 'properties' => [
- 'JqNodes' => [
- 'title' => '节点配置',
- 'description' => '节点配置',
- 'type' => 'array',
- 'items' => [
- 'title' => '节点',
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'example' => '节点key',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => '节点数据类型:string number list object base',
- 'type' => 'string',
- 'example' => '节点数据类型:string number list object base',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '节点路径',
- 'type' => 'string',
- 'example' => '节点路径',
- ],
- 'JqNodes' => [
- 'title' => '子节点配置',
- 'description' => '子节点配置',
- 'type' => 'array',
- 'items' => [
- 'title' => '子节点配置',
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'example' => 'title',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => '节点数据类型:string number list object base',
- 'type' => 'string',
- 'example' => 'string',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '节点路径',
- 'type' => 'string',
- 'example' => '.title',
- ],
- 'JqNodes' => [
- 'title' => '子节点配置',
- 'description' => '子节点配置',
- 'type' => 'array',
- 'items' => [
- 'title' => '子节点配置',
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'example' => 'title',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => '节点数据类型:string number list object base',
- 'type' => 'string',
- 'example' => 'string',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '节点路径',
- 'type' => 'string',
- 'example' => '.title',
- ],
- ],
- ],
- ],
- ],
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'SearchSourceConfig' => [
- 'description' => '数据集配置项',
- 'type' => 'object',
- 'properties' => [
- 'TagSearchEnable' => [
- 'description' => '标签是否参与搜索:默认true',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'TagGenerateEnable' => [
- 'description' => '标签是否参与生成:默认true',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'MetadataKeyValueSearchEnable' => [
- 'description' => 'metadata-keyValue 部分是否参与搜索:默认 true',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'MetadataKeyValueGenerateEnable' => [
- 'description' => 'metadata-keyValue 部分是否参与生成:默认 true',
- 'type' => 'string',
- 'example' => 'true',
- ],
- ],
- ],
+ 'Content' => ['description' => '总结内容', 'type' => 'string', 'example' => '总结内容'],
],
],
- 'DatasetDescription' => [
- 'title' => '数据集显示名称',
- 'description' => '数据集显示名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'SearchDatasetEnable' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DocumentHandleConfig' => [
- 'description' => '文档处理配置',
+ 'Usage' => [
+ 'description' => '大模型token用量信息',
'type' => 'object',
'properties' => [
- 'DisableHandleMultimodalMedia' => [
- 'title' => '禁用多媒体文件处理逻辑,默认为false',
- 'description' => '禁用多媒体文件处理逻辑,默认为false',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '3259D344-E871-5DE0-8FFE-CDA21F8D4382'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetConfig\\": {\\n \\"SearchSourceConfigs\\": [\\n {\\n \\"DemoQuery\\": \\"可以搜索到的关键词,用来验证是否可用\\",\\n \\"Size\\": 10,\\n \\"SearchSourceRequestConfig\\": {\\n \\"Url\\": \\"api地址\\",\\n \\"Method\\": \\"请求方式\\",\\n \\"ConnectTimeout\\": 30,\\n \\"SocketTimeout\\": 78,\\n \\"Headers\\": [\\n {\\n \\"Name\\": \\"参数名称\\",\\n \\"ValueType\\": \\"参数值数据类型:默认string\\",\\n \\"ValueFormat\\": \\"valueType = time 时有效\\",\\n \\"Value\\": \\"参数值\\"\\n }\\n ],\\n \\"Params\\": [\\n {\\n \\"Name\\": \\"参数名称\\",\\n \\"ValueType\\": \\"参数值数据类型:默认string\\",\\n \\"ValueFormat\\": \\"valueType = time 时有效\\",\\n \\"Value\\": \\"参数值\\"\\n }\\n ],\\n \\"PathParamsEnable\\": true,\\n \\"Body\\": \\"请求body\\"\\n },\\n \\"SearchSourceResponseConfig\\": {\\n \\"JqNodes\\": [\\n {\\n \\"Key\\": \\"节点key\\",\\n \\"Type\\": \\"节点数据类型:string number list object base\\",\\n \\"Path\\": \\"节点路径\\",\\n \\"JqNodes\\": [\\n {\\n \\"Key\\": \\"title\\",\\n \\"Type\\": \\"string\\",\\n \\"Path\\": \\".title\\",\\n \\"JqNodes\\": [\\n {\\n \\"Key\\": \\"title\\",\\n \\"Type\\": \\"string\\",\\n \\"Path\\": \\".title\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"SearchSourceConfig\\": {\\n \\"TagSearchEnable\\": \\"true\\",\\n \\"TagGenerateEnable\\": \\"true\\",\\n \\"MetadataKeyValueSearchEnable\\": \\"true\\",\\n \\"MetadataKeyValueGenerateEnable\\": \\"true\\"\\n }\\n },\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1,\\n \\"DocumentHandleConfig\\": {\\n \\"DisableHandleMultimodalMedia\\": true\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-详情',
- ],
- 'UpdateDataset' => [
- 'summary' => '数据源管理-更新。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => '文档摘要',
+ 'summary' => '针对一篇文章、视频或者URL,生成文章的摘要内容,即全文总结。此外支持多种多语言的输入和输出。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-27T11:04:18.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"92e16ccb-92b6-4894-abbf-fc6e2929a0df\\",\\n \\"TaskId\\": \\"b057f2fa-2277-477b-babf-cbc062307828\\",\\n \\"TraceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"总结内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"3259D344-E871-5DE0-8FFE-CDA21F8D4382\\"\\n}","type":"json"}]',
+ ],
+ 'RunDocTranslation' => [
+ 'path' => '/miaodu/stream/runDocTranslation',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集id',
- 'description' => '数据集id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => '2e6b3987-f743-4d4c-8326-d9c41a6af3ee'],
],
[
- 'name' => 'DatasetDescription',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集描述',
- 'description' => '数据集描述',
- 'type' => 'string',
- 'required' => false,
- 'example' => '企业自定义数据集',
- 'maxLength' => 30,
- 'minLength' => 0,
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => '12345'],
],
[
- 'name' => 'SearchDatasetEnable',
+ 'name' => 'TransType',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['description' => '翻译方式', 'type' => 'string', 'required' => false, 'example' => 'toChinese'."\n"
+ .'toEnglish'."\n"
+ .'toJapenese'."\n"
+ .'toRussian'."\n"
+ .'toFrench'."\n"
+ .'toGerman'."\n"
+ .'toItalian'."\n"
+ .'toKorean'."\n"
+ .'toSpanish'."\n"
+ .'toPortuguese'],
],
[
- 'name' => 'DatasetConfig',
+ 'name' => 'RecommendContent',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '三方搜索数据集配置',
- 'description' => '三方搜索数据集配置',
- 'type' => 'object',
- 'properties' => [
- 'SearchSourceConfigs' => [
- 'title' => '三方搜索:api定义',
- 'description' => '三方搜索:api定义',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'DemoQuery' => [
- 'title' => '可以搜索到的关键词,用来验证是否可用',
- 'description' => '可以搜索到的关键词,用来验证是否可用',
- 'type' => 'string',
- 'required' => false,
- 'example' => '可以搜索到的关键词,用来验证是否可用',
- ],
- 'Size' => [
- 'title' => '默认请求、响应数据条数限制',
- 'description' => '默认请求、响应数据条数限制',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- 'SearchSourceRequestConfig' => [
- 'title' => 'api请求配置',
- 'description' => 'api请求配置',
- 'type' => 'object',
- 'properties' => [
- 'Url' => [
- 'title' => 'api地址',
- 'description' => 'api地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'api地址',
- ],
- 'Method' => [
- 'title' => '请求方式',
- 'description' => '请求方式',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请求方式',
- ],
- 'ConnectTimeout' => [
- 'title' => '连接超时时间:单位毫秒',
- 'description' => '连接超时时间:单位毫秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3000',
- ],
- 'SocketTimeout' => [
- 'title' => '读超时时间:单位毫秒',
- 'description' => '读超时时间:单位毫秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3000',
- ],
- 'Headers' => [
- 'description' => 'http请求头',
- 'type' => 'array',
- 'items' => [
- 'description' => 'http请求头',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数名称',
- ],
- 'ValueType' => [
- 'title' => '参数值数据类型: 默认string',
- 'description' => '参数值数据类型:默认string',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值数据类型:默认string',
- ],
- 'ValueFormat' => [
- 'title' => 'valueType = time 时有效',
- 'description' => 'valueType = time 时有效',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'valueType = time 时有效',
- ],
- 'Value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'Params' => [
- 'title' => '请求path参数',
- 'description' => '请求path参数',
- 'type' => 'array',
- 'items' => [
- 'description' => '请求path参数',
- 'type' => 'object',
- 'properties' => [
- 'Name' => [
- 'title' => '参数名称',
- 'description' => '参数名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数名称',
- ],
- 'ValueType' => [
- 'title' => '参数值数据类型: 默认string',
- 'description' => '参数值数据类型:默认string',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值数据类型:默认string',
- ],
- 'ValueFormat' => [
- 'title' => 'valueType = time 时有效',
- 'description' => 'valueType = time 时有效',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'valueType = time 时有效',
- ],
- 'Value' => [
- 'title' => '参数值',
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '参数值',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'PathParamsEnable' => [
- 'title' => '是否开启pathParam',
- 'description' => '是否开启pathParam',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'Body' => [
- 'title' => '请求body',
- 'description' => '请求body',
- 'type' => 'string',
- 'required' => false,
- 'example' => '{}',
- ],
- ],
- 'required' => false,
- ],
- 'SearchSourceResponseConfig' => [
- 'title' => 'api响应配置',
- 'description' => 'api响应配置',
- 'type' => 'object',
- 'properties' => [
- 'JqNodes' => [
- 'title' => '节点配置',
- 'description' => '节点配置',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'title' => '节点key',
- 'description' => '节点key',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点key',
- ],
- 'Type' => [
- 'title' => '节点数据类型:string number list object base',
- 'description' => '节点数据类型:string number list object base',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点数据类型:string number list object base',
- ],
- 'Path' => [
- 'title' => '节点路径',
- 'description' => '节点路径',
- 'type' => 'string',
- 'required' => false,
- 'example' => '节点路径',
- ],
- 'JqNodes' => [
- 'title' => '子节点配置',
- 'description' => '子节点配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '节点key',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'title',
- ],
- 'Type' => [
- 'description' => 'type类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'string',
- ],
- 'Path' => [
- 'description' => '节点路径',
- 'type' => 'string',
- 'required' => false,
- 'example' => '.title',
- ],
- 'JqNodes' => [
- 'description' => '子节点配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '子节点配置',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '节点key',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'title',
- ],
- 'Type' => [
- 'description' => 'type类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'string',
- ],
- 'Path' => [
- 'description' => '节点路径',
- 'type' => 'string',
- 'required' => false,
- 'example' => '.title',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'SearchSourceConfig' => [
- 'description' => '数据集配置项',
- 'type' => 'object',
- 'properties' => [
- 'TagSearchEnable' => [
- 'description' => '标签是否参与搜索:默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'TagGenerateEnable' => [
- 'description' => '标签是否参与生成:默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'MetadataKeyValueSearchEnable' => [
- 'description' => 'metadata-keyValue 部分是否参与搜索:默认 true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- 'MetadataKeyValueGenerateEnable' => [
- 'description' => 'metadata-keyValue 部分是否参与生成:默认 true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '要翻译的内容', 'type' => 'string', 'required' => false, 'example' => '要翻译的内容'],
+ ],
+ [
+ 'name' => 'CleanCache',
+ 'in' => 'formData',
+ 'schema' => ['description' => '是否清除当前缓存', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'DatasetId' => [
- 'title' => '数据集ID',
- 'description' => '数据集ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-12 21:46:24',
- ],
- 'DatasetType' => [
- 'title' => '数据集类型',
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'CustomSemanticSearch',
- ],
- 'DatasetName' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DatasetDescription' => [
- 'title' => '数据集显示名称',
- 'description' => '数据集显示名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'SearchDatasetEnable' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'success'],
+ 'ErrorMessage' => ['description' => '错误码消息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'task-started'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '411c4dfa-2168-4379-a902-675d67f453f8'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '50a1cc8e-717e-4a2b-a76b-dc9734a8564b'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => 'ebd19b12-0cae-488f-9e41-5a1c825f545b'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '翻译内容', 'type' => 'string', 'example' => '翻译内容'],
+ ],
],
- 'NewsArticleResults' => [
- 'description' => '文章列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章列表',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'description' => '文章列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章',
- 'type' => 'object',
- 'properties' => [
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-11-12 15:12:14',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '央视网',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- ],
- ],
- ],
- 'Current' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'title' => '总记录条数',
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- ],
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
],
],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1,\\n \\"NewsArticleResults\\": [\\n {\\n \\"Data\\": [\\n {\\n \\"PubTime\\": \\"2024-11-12 15:12:14\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\",\\n \\"Summary\\": \\"文章摘要\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 100,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-修改',
- ],
- 'ListDatasets' => [
- 'summary' => '数据源管理-查询。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
+ ],
+ 'title' => '文档翻译',
+ 'summary' => '中英文互译接口。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocTranslation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"411c4dfa-2168-4379-a902-675d67f453f8\\",\\n \\"TaskId\\": \\"50a1cc8e-717e-4a2b-a76b-dc9734a8564b\\",\\n \\"TraceId\\": \\"ebd19b12-0cae-488f-9e41-5a1c825f545b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"翻译内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n}","type":"json"}]',
+ ],
+ 'RunDocWashing' => [
+ 'path' => '/quanmiao/aimiaobi/runDocWashing',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'StartTime',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建时间-开始',
- 'description' => '创建时间-开始',
- 'type' => 'string',
- 'required' => false,
- 'example' => '创建时间-开始',
- ],
+ 'schema' => ['description' => '通道Id', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'EndTime',
+ 'name' => 'WritingTypeName',
'in' => 'formData',
- 'schema' => [
- 'title' => '创建时间-结束',
- 'description' => '创建时间-结束',
- 'type' => 'string',
- 'required' => false,
- 'example' => '创建时间-结束',
- ],
+ 'schema' => ['description' => '文体类型名字', 'type' => 'string', 'required' => false, 'example' => '小红书文体'."\n"
+ .'朋友圈文体'."\n"
+ .'专业新闻文体'."\n"
+ .'政府公文文体'."\n"
+ .'报纸文章文体'."\n"
+ .'意见信文体'],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'WritingTypeRefDoc',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称,全局唯一',
- 'description' => '数据集名称,全局唯一',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'businessDataset',
- ],
+ 'schema' => ['description' => '文体示例文章', 'type' => 'string', 'required' => false, 'example' => '该值若不为空则按该值优先'],
],
[
- 'name' => 'DatasetId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '数据集id',
- 'description' => '数据集id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
+ 'name' => 'ReferenceContent',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数',
- 'description' => '每页条数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['description' => '要进行改写的文章', 'type' => 'string', 'required' => true, 'example' => '文章内容'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页:默认1',
- 'description' => '当前页:默认1',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- 'default' => '1',
- ],
+ 'schema' => ['description' => '改写文章主题', 'type' => 'string', 'required' => false, 'example' => '云南旅游主题'],
],
[
- 'name' => 'DatasetType',
+ 'name' => 'WordNumber',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集类型',
- 'description' => '数据集类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'CustomSemanticSearch',
- ],
+ 'schema' => ['description' => '改写后的字数要求', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500'],
],
[
- 'name' => 'SearchDatasetEnable',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['description' => '附加要求提示词', 'type' => 'string', 'required' => false, 'example' => '按英文输出'],
],
[
- 'name' => 'IncludeConfig',
+ 'name' => 'ModelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '是否返回配置和用量信息,默认不返回',
- 'description' => '是否返回配置和用量信息,默认不返回',
- 'type' => 'boolean',
- 'required' => false,
- 'default' => 'true',
- ],
+ 'schema' => ['description' => '模型id', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'DatasetId' => [
- 'title' => '数据集ID',
- 'description' => '数据集ID',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'CreateUser' => [
- 'title' => '创建者',
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-12 21:46:24',
- ],
- 'DatasetType' => [
- 'title' => '数据集类型',
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'CustomSemanticSearch',
- ],
- 'DatasetName' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DatasetDescription' => [
- 'title' => '数据集显示名称',
- 'description' => '数据集显示名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'SearchDatasetEnable' => [
- 'title' => '数据集搜索开关',
- 'description' => '数据集搜索开关',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DocUsedQuota' => [
- 'title' => '当前数据集已上传文档总数',
- 'description' => '当前数据集已上传文档总数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TotalCount' => [
- 'title' => '总条数',
- 'description' => '总条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'PageSize' => [
- 'title' => '每页条数',
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'CustomSemanticSearchConfig' => [
- 'title' => '"上传文件用作数据源"场景索引配置和用量信息',
- 'description' => '"上传文件用作数据源"场景索引配置和用量信息',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'End' => ['description' => '响应包是否结束', 'type' => 'boolean', 'example' => 'false'],
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'DocQuota' => [
- 'title' => '总文档配额',
- 'description' => '总文档配额',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'DocUsedQuota' => [
- 'title' => '总文档已使用配额',
- 'description' => '总文档已使用配额',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'DatasetQuota' => [
- 'title' => '数据集数量配额',
- 'description' => '数据集数量配额',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '3',
- ],
- 'DatasetUsedQuota' => [
- 'title' => '数据集数量已使用配额',
- 'description' => '数据集数量已使用配额',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'task-finished'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'RequestId' => ['description' => '请求RequestId', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '20247a52-23e2-46fb-943d-309cdee2bc6d'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'],
],
],
- 'ThirdSearchConfig' => [
- 'title' => '"通过API引入数据源"场景配置和用量信息',
- 'description' => '"通过API引入数据源"场景配置和用量信息',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'DatasetQuota' => [
- 'title' => '数据集数量配额',
- 'description' => '数据集数量配额',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => '输出内容', 'type' => 'string', 'example' => '文本生成结果'],
+ ],
],
- 'DatasetUsedQuota' => [
- 'title' => '数据集数量已使用配额',
- 'description' => '数据集数量已使用配额',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
+ 'Usage' => [
+ 'description' => 'token消耗',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
],
],
],
@@ -30769,884 +19983,386 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1,\\n \\"DocUsedQuota\\": 1\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"CustomSemanticSearchConfig\\": {\\n \\"DocQuota\\": 1000,\\n \\"DocUsedQuota\\": 1,\\n \\"DatasetQuota\\": 3,\\n \\"DatasetUsedQuota\\": 1\\n },\\n \\"ThirdSearchConfig\\": {\\n \\"DatasetQuota\\": 2,\\n \\"DatasetUsedQuota\\": 1\\n }\\n}","type":"json"}]',
- 'title' => '数据源-列表',
- ],
- 'DeleteDataset' => [
- 'summary' => '数据源管理-删除。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '改写',
+ 'summary' => '把一篇文章改换成指定风格。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocWashing',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"Event\\": \\"task-finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"20247a52-23e2-46fb-943d-309cdee2bc6d\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\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"}]',
+ ],
+ 'RunExpandContent' => [
+ 'path' => '/quanmiao/aimiaobi/runExpandContent',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间id', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '需要扩写的内容', 'description' => '需要扩写的内容', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义提示词', 'description' => '自定义提示词', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
+ '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' => '模型生成事件'],
+ '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'],
+ ],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'Payload' => [
+ 'title' => '返回结果的 payload,json 结构',
+ 'description' => '返回结果的 payload,json 结构',
+ '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' => '总oken数量', 'description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
+ ],
+ ],
+ ],
],
+ 'RequestId' => ['title' => '请求唯一ID', 'description' => '请求唯一ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-删除',
- ],
- 'AddDatasetDocument' => [
- 'summary' => '添加文档到数据源。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '内容扩写',
+ 'summary' => '内容扩写。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunExpandContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
+ ],
+ 'RunGenerateQuestions' => [
+ 'path' => '/miaodu/stream/runGenerateQuestions',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-w335gauzlbba2vze'],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => false, 'example' => 'f486c4e2-b773-4d65-88f8-2ba540610456'],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数据集名称',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => 'oOgIwodFANW1u5MnqxysOh1rtld3xn'],
],
[
- 'name' => 'Document',
+ 'name' => 'ReferenceContent',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['description' => '要从中提取问题的文档内容,如果不为空则以此文本为准,为空则以docId为准', 'type' => 'string', 'required' => false, 'example' => '关联内容'],
+ ],
+ [
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '文档',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'DocUuid' => [
- 'title' => '内部文档唯一ID',
- 'description' => '文档系统唯一ID:自动生成,不建议传入',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'Url' => [
- 'description' => '文章URL:公网可访问地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx',
- ],
- 'Content' => [
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [],
- 'example' => '正文',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章摘要',
- ],
- 'Title' => [
- 'description' => '文档标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标题',
- ],
- 'PubTime' => [
- 'description' => '发布时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-12-09 13:35:40',
- ],
- 'SourceFrom' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx媒体',
- ],
- 'MultimodalIndexName' => [
- 'title' => '模型名称 todo 商业化 仅个别账号可传入',
- 'description' => '废弃:不可用',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'DisableHandleMultimodalMedia' => [
- 'title' => '当前记录是否落多模态索引库',
- 'description' => '当前记录多模态数据(图片、视频)是否落索引库,默认true',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'MultimodalMedias' => [
- 'description' => '文档中多模态数据列表:'."\n"
- .'- 仅富文本等文档中存在多模态数据(图片、视频)时,可以通过这个字段传入,进而可以在搜索接口召回对应数据。'."\n"
- .'- 文档本身为多模态数据时,此字段为空,通过docType+url指定数据即可。',
- 'type' => 'array',
- 'items' => [
- 'description' => '多模态数据',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识:不建议传入,系统会自动生成',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据类型:'."\n"
- .'- image:图片'."\n"
- .'- video:视频',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'image',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件地址:公网可访问',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx',
- ],
- ],
- 'required' => false,
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'RateLimit'],
+ 'ErrorMessage' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => 'event名称', 'type' => 'string', 'example' => 'finished'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0bc3b4b417362160345997589e5f6e'],
],
- 'required' => false,
- ],
- 'DocId' => [
- 'title' => '业务文档唯一ID',
- 'description' => '文档业务侧唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'DocType' => [
- 'title' => '文档类型',
- 'description' => '文档类型:'."\n"
- .'- plainText:纯文本,content必选'."\n"
- .'- richText:富文本:html,content必选'."\n"
- .'- text:文本文件,url必选'."\n"
- .'- pdf:url必选'."\n"
- .'- word:url必选'."\n"
- .'- image:图片,url必选,支持gif、png、jpg、jpeg等大多数常见图片格式'."\n"
- .'- video:视频,url必选,支持MP4、AVI、WMV、MOV等大多数常见视频格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'image',
],
- 'Extend1' => [
- 'title' => '扩展字段1',
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'Extend2' => [
- 'title' => '扩展字段2',
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'Extend3' => [
- 'title' => '扩展字段3',
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'Metadata' => [
- 'title' => '字典信息:目前仅视频支持',
- 'description' => 'meta信息',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'VideoShots' => [
- 'title' => '视频分镜信息:比如视频理解语言分析结果',
- 'description' => '分镜信息',
- 'type' => 'array',
- 'items' => [
- 'title' => '分镜信息',
- 'description' => '分镜信息',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'title' => '分镜开始时间:单位毫秒',
- 'description' => '开始时间;毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000',
- ],
- 'EndTime' => [
- 'title' => '分镜结束时间:单位毫秒',
- 'description' => '结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2000',
- ],
- 'Text' => [
- 'title' => '分镜:总结内容',
- 'description' => '分镜分析文本信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'AsrSentences' => [
- 'title' => 'asr结果',
- 'description' => '语音或者字幕信息',
- 'type' => 'array',
- 'items' => [
- 'title' => 'asr结果',
- 'description' => '语音或者字幕信息',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'title' => '开始时间:单位毫秒',
- 'description' => '开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1000',
- ],
- 'EndTime' => [
- 'title' => '结束时间:单位毫秒',
- 'description' => '技术时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2000',
- ],
- 'Text' => [
- 'title' => 'asr内容',
- 'description' => '语音或者字幕信息',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- 'required' => false,
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['description' => '问题内容', 'type' => 'string', 'example' => '问题1\\n问题2\\n问题3\\n'],
],
- 'required' => false,
],
- 'Text' => [
- 'title' => '整体总结信息',
- 'description' => 'meta描述信息:废弃字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'KeyValues' => [
- 'description' => 'keyValue结构metadata',
- 'type' => 'array',
- 'items' => [
- 'description' => 'keyValue结构metadata',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'Value' => [
- 'description' => '参数值',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- 'required' => false,
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '200'],
],
- 'required' => false,
],
],
- 'required' => false,
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'Tags' => [
- 'description' => '标签名称',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
],
],
- 'required' => true,
],
],
],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'DocUuid' => [
- 'description' => '文档系统唯一标识',
- 'type' => 'string',
- 'example' => '8df2d69d63a247b6b52ff455b2d426b6',
- ],
- 'DocId' => [
- 'title' => '文档业务唯一标识',
- 'description' => '文档业务侧唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Status' => [
- 'title' => '状态:',
- 'description' => '状态:'."\n"
- .'- 1:创建完成'."\n"
- .'- 2:文本索引构建完成'."\n"
- .'- 3:多模态索引构建完成'."\n"
- .'- 100:全量构建完成'."\n"
- .'- 0:失败',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'ErrorCode' => [
- 'description' => '异常错误码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '猜你想问',
+ 'summary' => '输入一个query,返回几个相关query。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DocUuid\\": \\"8df2d69d63a247b6b52ff455b2d426b6\\",\\n \\"DocId\\": \\"xxx\\",\\n \\"Status\\": 1,\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"错误信息\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-添加文档到数据集',
- ],
- 'GetDatasetDocument' => [
- 'summary' => '获取数据源文档。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunGenerateQuestions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"RateLimit\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"TaskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"TraceId\\": \\"0bc3b4b417362160345997589e5f6e\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"问题1\\\\\\\\n问题2\\\\\\\\n问题3\\\\\\\\n\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunHotword' => [
+ 'path' => '/miaodu/stream/runHotword',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-baw8as25ll3wnzjr'],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '会话ID。', 'type' => 'string', 'required' => false, 'example' => 'e32a1a3f-1f7e-41dd-b888-ef1d91b96d1e'],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'DocId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数据集名称',
- ],
+ 'schema' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55'],
],
[
- 'name' => 'DocUuid',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '提示词', 'type' => 'string', 'required' => false, 'example' => '提示词'],
],
[
- 'name' => 'DocId',
+ 'name' => 'ReferenceContent',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['description' => '要从中提取热词的文档内容,不为空则按该内容提取,为空则按docId提取', 'type' => 'string', 'required' => false, 'example' => '关联内容'],
],
[
- 'name' => 'IncludeFields',
+ 'name' => 'ModelName',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '包含的字段列表',
- 'description' => '包含的字段列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '包含的字段:比如metadata',
- 'description' => '包含的字段:比如 metadata',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'metadata',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'DocUuid' => [
- 'title' => '内部文档唯一ID',
- 'description' => '文档系统唯一ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Url' => [
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.aliyun.com',
- ],
- 'Content' => [
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文档标题'."\n"
- ."\n",
- ],
- 'PubTime' => [
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2024-05-14 08:54:33',
- ],
- 'SourceFrom' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '来源',
- ],
- 'DisableHandleMultimodalMedia' => [
- 'title' => '当前记录是否落多模态索引库',
- 'description' => '当前记录是否落多模态索引库',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DocId' => [
- 'title' => '用户指定的文档唯一ID',
- 'description' => '文档用户侧唯一ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Metadata' => [
- 'title' => '字典信息',
- 'description' => '字典信息',
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => '200'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'success'],
+ 'Event' => ['description' => '事件类型。', 'type' => 'string', 'example' => 'finished'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话id', 'type' => 'string', 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0abb7e3217356108993888059ee72b'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
'type' => 'object',
'properties' => [
- 'Text' => [
- 'title' => '文档维度meta',
- 'description' => '文档维度meta',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'VideoShots' => [
- 'title' => '视频分片信息',
- 'description' => '视频分片信息',
- 'type' => 'array',
- 'items' => [
- 'title' => '视频分片信息',
- 'description' => '视频分片信息',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'title' => '视频分片开始时间:毫秒',
- 'description' => '视频分片开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'EndTime' => [
- 'title' => '视频分片结束时间:毫秒',
- 'description' => '视频分片结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'Text' => [
- 'title' => '视频分片:内容',
- 'description' => '视频分片:内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- ],
- 'AsrSentences' => [
- 'title' => 'asr结果',
- 'description' => 'asr结果',
- 'type' => 'array',
- 'items' => [
- 'title' => 'asr结果',
- 'description' => 'asr结果',
- 'type' => 'object',
- 'properties' => [
- 'StartTime' => [
- 'title' => '开始时间:毫秒',
- 'description' => '开始时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1000',
- ],
- 'EndTime' => [
- 'title' => '结束时间:毫秒',
- 'description' => '结束时间:毫秒',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2000',
- ],
- 'Text' => [
- 'title' => 'asr内容',
- 'description' => 'asr内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- ],
- ],
- ],
- 'KeyValues' => [
- 'description' => 'key-value结构的metadata',
- 'type' => 'array',
- 'items' => [
- 'description' => 'keyValue结构metadata',
- 'type' => 'object',
- 'properties' => [
- 'Key' => [
- 'description' => '参数名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Value' => [
- 'description' => '参数值',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
+ 'Content' => ['description' => '热词内容', 'type' => 'string', 'example' => '全球影响,文化交流,孙悟空,动画改编'],
],
],
- 'DocType' => [
- 'title' => '文档类型:比如video、image',
- 'description' => '文档类型:比如video、image',
- 'type' => 'string',
- 'example' => 'video',
- ],
- 'Status' => [
- 'title' => '文档状态',
- 'description' => '文档状态:100:成功 0:失败 1:索引或排队中',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Tags' => [
- 'description' => '标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'example' => 'xx',
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TotalTokens' => ['description' => '总token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '101'],
],
],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DocUuid\\": \\"xxx\\",\\n \\"Url\\": \\"https://www.aliyun.com\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Title\\": \\"文档标题\\\\n\\\\n\\",\\n \\"PubTime\\": \\"2024-05-14 08:54:33\\",\\n \\"SourceFrom\\": \\"来源\\",\\n \\"DisableHandleMultimodalMedia\\": true,\\n \\"DocId\\": \\"xxx\\",\\n \\"Metadata\\": {\\n \\"Text\\": \\"xx\\",\\n \\"VideoShots\\": [\\n {\\n \\"StartTime\\": 1000,\\n \\"EndTime\\": 2000,\\n \\"Text\\": \\"xxx\\"\\n }\\n ],\\n \\"AsrSentences\\": [\\n {\\n \\"StartTime\\": 1000,\\n \\"EndTime\\": 2000,\\n \\"Text\\": \\"xxx\\"\\n }\\n ],\\n \\"KeyValues\\": [\\n {\\n \\"Key\\": \\"xx\\",\\n \\"Value\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"DocType\\": \\"video\\",\\n \\"Status\\": 100,\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-获取文档详情',
- ],
- 'UpdateDatasetDocument' => [
- 'summary' => '修改数据源文档。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '抽取关键词',
+ 'summary' => '基于指定文章抽取关键词。关键词主要是指在特定领域或行业中具有代表性和识别度的专业术语或概念,它们能够精准地描述和概括某一行业内的核心内容、重要人物、关键事件或技术名词。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunHotword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"92e16ccb-92b6-4894-abbf-fc6e2929a0df\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0abb7e3217356108993888059ee72b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"全球影响,文化交流,孙悟空,动画改编\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 101\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunKeywordsExtractionGeneration' => [
+ 'path' => '/quanmiao/aimiaobi/runKeywordsExtractionGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -31654,1367 +20370,521 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'Document',
+ 'name' => 'ReferenceData',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '文档',
+ 'description' => '生成需要的数据',
'type' => 'object',
'properties' => [
- 'DocUuid' => [
- 'title' => '内部文档唯一ID',
- 'description' => '文档系统唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'Title' => [
- 'description' => '文档标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '用户指定的文档唯一ID',
- 'description' => '文档用户侧唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'Tags' => [
- 'description' => '标签',
+ 'Contents' => [
+ 'description' => '正文列表',
'type' => 'array',
- 'items' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
+ 'items' => ['description' => '正文', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
+ 'required' => true,
],
],
'required' => true,
],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '关联创作文章唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数据集名称',
- ],
+ 'schema' => ['title' => '自定义提示词', 'description' => '自定义提示词', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'DocUuid' => [
- 'title' => '内部文档唯一ID',
- 'description' => '内部文档唯一ID',
- 'type' => 'string',
- 'example' => '内部文档唯一ID',
- ],
- 'Title' => [
- 'description' => '文档标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'DocId' => [
- 'title' => '用户指定的文档唯一ID',
- 'description' => '用户指定的文档唯一ID',
- 'type' => 'string',
- 'example' => '用户指定的文档唯一ID',
- ],
- 'Tags' => [
- 'description' => '标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'example' => 'xx',
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'AccessForbid'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'xx'],
+ 'Event' => ['description' => 'SSE事件。', 'type' => 'string', 'example' => 'task-failed'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '1a3d7c9f-3a6d-4e49-b176-2d8721a27397'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '8d55b429d7c6d321fcff54823e8d317b'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '210bc4e817219607963985396de8bd'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => '文本生成结果', 'type' => 'string', 'example' => 'xxx'],
],
],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ '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'],
+ ],
],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '419F3FBE-5C8D-5949-AC29-E9615235D15A'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DocUuid\\": \\"内部文档唯一ID\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"DocId\\": \\"用户指定的文档唯一ID\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-修改文档',
- ],
- 'ListDatasetDocuments' => [
- 'summary' => '查询数据源文档列表。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '关键词抽取',
+ 'summary' => 'AI妙笔-创作-抽取关键词。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunKeywordsExtractionGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"1a3d7c9f-3a6d-4e49-b176-2d8721a27397\\",\\n \\"TaskId\\": \\"8d55b429d7c6d321fcff54823e8d317b\\",\\n \\"TraceId\\": \\"210bc4e817219607963985396de8bd\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xxx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"419F3FBE-5C8D-5949-AC29-E9615235D15A\\"\\n}","type":"json"}]',
+ ],
+ 'RunMultiDocIntroduction' => [
+ 'path' => '/miaodu/stream/runMultiDocIntroduction',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '搜索条件',
- 'description' => '搜索条件',
- 'type' => 'string',
- 'required' => false,
- 'example' => '搜索条件',
- ],
- ],
- [
- 'name' => 'DatasetId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识:DatasetName、DatasetId 二选一必填',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'DatasetName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数据集名称',
- ],
- ],
- [
- 'name' => 'Status',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档索引构建状态',
- 'description' => '文档状态:'."\n"
- .'- 1:创建完成'."\n"
- .'- 2:文本索引构建完成'."\n"
- .'- 3:多模态索引构建完成'."\n"
- .'- 100:全量构建完成'."\n"
- .'- 0:失败',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '100',
- ],
- ],
- [
- 'name' => 'DocType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '文档类型',
- 'description' => '文档类型:'."\n"
- .'- plainText:纯文本'."\n"
- .'- richText:富文本'."\n"
- .'- text:文本文件'."\n"
- .'- pdf:'."\n"
- .'- word:'."\n"
- .'- image:图片'."\n"
- .'- video:视频',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text',
- ],
- ],
- [
- 'name' => 'DatasetDescription',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '废弃',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'IncludeFields',
+ 'name' => 'DocIds',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '包括字段',
- 'description' => '包括字段',
+ 'description' => '多个文档Id数组',
'type' => 'array',
- 'items' => [
- 'description' => '包括字段'."\n"
- .'- content:正文'."\n"
- .'- chunks:片段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'content',
- ],
- 'required' => false,
+ 'items' => ['description' => '文档Id', 'type' => 'string', 'required' => false, 'example' => '10022'],
+ 'required' => true,
],
],
[
- 'name' => 'ExcludeFields',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '排除字段',
- 'description' => '排除字段:'."\n"
- .'- content:正文',
- 'type' => 'array',
- 'items' => [
- 'description' => '排除字段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'content',
- ],
- 'required' => false,
- ],
+ 'schema' => ['description' => '对话ID', 'type' => 'string', 'required' => true, 'example' => '75bf82fa-b71b-45d7-ae40-0b00e496cd9e'],
],
[
- 'name' => 'PageNumber',
+ 'name' => 'SummaryPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '1',
- ],
+ 'schema' => ['description' => '摘要-自定义Prompt', 'type' => 'string', 'required' => false, 'example' => '请简明扼要'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'KeyPointPrompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '10',
- ],
+ 'schema' => ['description' => '重点-自定义Prompt', 'type' => 'string', 'required' => false, 'example' => '请简明扼要'],
],
[
- 'name' => 'CategoryUuids',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '类目唯一标识',
- 'type' => 'array',
- 'items' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Tags',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Extend1',
- 'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'Extend2',
- 'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'Extend3',
- 'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'CreateTimeStart',
- 'in' => 'query',
- 'schema' => [
- 'description' => '起始创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- ],
- [
- 'name' => 'CreateTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'description' => '截止创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- ],
- [
- 'name' => 'DocUuids',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档唯一标识',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'DocIds',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档ID数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '发布开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1754446626000',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '发布结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- ],
- [
- 'name' => 'Title',
- 'in' => 'query',
- 'schema' => [
- 'description' => '文档标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'name' => 'ModelName',
+ 'in' => 'formData',
+ 'schema' => ['description' => '用户自定义模型名称', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n"],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'DocUuid' => [
- 'title' => '内部文档唯一ID',
- 'description' => '内部文档唯一ID',
- 'type' => 'string',
- 'example' => '内部文档唯一ID',
- ],
- 'Url' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'https://xxx/xx',
- ],
- 'Content' => [
- 'title' => '正文',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2022-01-01 00:00:00',
- ],
- 'SourceFrom' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '来源',
- ],
- 'DisableHandleMultimodalMedia' => [
- 'title' => '当前记录是否落多模态索引库',
- 'description' => '当前记录是否落多模态索引库',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'MultimodalMedias' => [
- 'description' => '多模态信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '多模态信息',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => '多模态数据唯一标识',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据类型',
- 'type' => 'string',
- 'example' => '多模态数据类型',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '图片或视频文件地址',
- 'type' => 'string',
- 'example' => '图片或视频文件地址',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => '200'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'Message does not exist.'],
+ 'Event' => ['description' => 'SSE事件。', 'type' => 'string', 'example' => 'finished'],
+ 'EventInfo' => ['description' => '事件描述', 'type' => 'string', 'example' => '模型生成事件'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'b057f2fa-2277-477b-babf-cbc062307828'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Summary' => ['description' => '大纲摘要', 'type' => 'string', 'example' => '大纲摘要内容'],
+ 'KeyPoints' => [
+ 'description' => '关键点信息。',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '关键点信息。',
+ 'type' => 'object',
+ 'properties' => [
+ 'KeyPoint' => ['description' => '关键点信息', 'type' => 'string', 'example' => '关键点信息'],
+ 'Source' => ['description' => '信息来源', 'type' => 'string', 'example' => '信息来源'],
],
],
],
],
- 'DocId' => [
- 'title' => '用户指定的文档唯一ID',
- 'description' => '用户指定的文档唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocType' => [
- 'title' => '文档类型',
- 'description' => '文档类型',
- 'type' => 'string',
- 'example' => 'text',
- ],
- 'Status' => [
- 'title' => '文档索引构建状态',
- 'description' => '文档索引构建状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'CategoryUuid' => [
- 'title' => '类目唯一标识',
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'title' => '扩展字段1',
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'title' => '扩展字段2',
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'title' => '扩展字段3',
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2025-04-14 19:59:53',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2025-04-14 19:59:53',
- ],
- 'UpdateUser' => [
- 'description' => '更新用户',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'CreateUser' => [
- 'description' => '创建者',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'Tags' => [
- 'description' => '标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ ],
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '65'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '165'],
],
],
],
],
- 'PageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录条数',
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"DocUuid\\": \\"内部文档唯一ID\\",\\n \\"Url\\": \\"https://xxx/xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"PubTime\\": \\"2022-01-01 00:00:00\\",\\n \\"SourceFrom\\": \\"来源\\",\\n \\"DisableHandleMultimodalMedia\\": false,\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"DocType\\": \\"text\\",\\n \\"Status\\": 100,\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"CreateTime\\": \\"2025-04-14 19:59:53\\",\\n \\"UpdateTime\\": \\"2025-04-14 19:59:53\\",\\n \\"UpdateUser\\": \\"1\\",\\n \\"CreateUser\\": \\"1\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-文档列表',
- ],
- 'SearchDatasetDocuments' => [
- 'summary' => '搜索数据源文档。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '多文档聚合摘要',
+ 'summary' => '针对多篇文章、视频或者URL,生成总分结构的摘要(几篇文章的综合概述、关键要点)。此外支持多种多语言的输入和输出。',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => '请求参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunMultiDocIntroduction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Message does not exist.\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"92e16ccb-92b6-4894-abbf-fc6e2929a0df\\",\\n \\"TaskId\\": \\"b057f2fa-2277-477b-babf-cbc062307828\\",\\n \\"TraceId\\": \\"46e5c2b5-0877-4f09-bd91-ab0cf314e48b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Summary\\": \\"大纲摘要内容\\",\\n \\"KeyPoints\\": [\\n {\\n \\"KeyPoint\\": \\"关键点信息\\",\\n \\"Source\\": \\"信息来源\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 65,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 165\\n }\\n }\\n}","type":"json"}]',
+ ],
+ 'RunPptOutlineGeneration' => [
+ 'path' => '/pop/ppt/runPptOutlineGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-8v8a5mfpxffrj1pn'],
],
[
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '搜索内容',
- 'description' => '搜索内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => '搜索内容',
- ],
- ],
- [
- 'name' => 'DatasetId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识:和DatasetName二选一必选',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'DatasetName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数据集名称',
- ],
- ],
- [
- 'name' => 'IncludeContent',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '默认 false',
- 'description' => '是否包含正文:默认 false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- ],
- [
- 'name' => 'Extend1',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务参数',
- 'description' => '业务参数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '业务参数',
- ],
+ 'schema' => ['title' => '用户问题', 'description' => '用户问题', 'type' => 'string', 'required' => true, 'example' => '帮我生成一个消防安全主题的PPT'],
],
[
- 'name' => 'PageSize',
+ 'name' => 'ExternalUserId',
'in' => 'formData',
- 'schema' => [
- 'title' => '返回数据条数',
- 'description' => '返回数据条数',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10',
- 'default' => '10',
- ],
- ],
- [
- 'name' => 'CategoryUuids',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '类目唯一标识',
- 'type' => 'array',
- 'items' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'x',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Tags',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'Extend2',
- 'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'Extend3',
- 'in' => 'query',
- 'schema' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'CreateTimeStart',
- 'in' => 'query',
- 'schema' => [
- 'description' => '起始创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111111111111',
- ],
- ],
- [
- 'name' => 'CreateTimeEnd',
- 'in' => 'query',
- 'schema' => [
- 'description' => '截止创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- ],
- [
- 'name' => 'StartTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '开始时间的时间戳,精确到毫秒。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1760063038858',
- ],
- ],
- [
- 'name' => 'EndTime',
- 'in' => 'query',
- 'schema' => [
- 'description' => '结束时间,精确到毫秒(ms)。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- ],
- [
- 'name' => 'DocUuids',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档唯一标识',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'DocIds',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档ID数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
- 'required' => false,
- ],
- ],
- [
- 'name' => 'SearchMode',
- 'in' => 'query',
- 'schema' => [
- 'description' => '搜索模式:document(默认),chunk,文档型数据返回列表是文档维度还是chunk维度',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'document',
- ],
- ],
- [
- 'name' => 'DocTypes',
- 'in' => 'query',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档类型',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档类型:text image video audio pdf word ppt等',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text',
- ],
- 'required' => false,
- ],
+ 'schema' => ['type' => 'string', 'example' => 'abc'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Header' => [
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'Documents' => [
- 'title' => '文本数据',
- 'description' => '文档列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档列表',
- 'type' => 'object',
- 'properties' => [
- 'DocUuid' => [
- 'title' => '内部文档唯一ID',
- 'description' => '文档系统唯一ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Url' => [
- 'description' => 'URL链接',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Content' => [
- 'description' => '内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'PubTime' => [
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2024-12-09 17:09:40',
- ],
- 'SourceFrom' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '来源',
- ],
- 'DocId' => [
- 'title' => '用户指定的文档唯一ID',
- 'description' => '文档用户侧唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocType' => [
- 'description' => '文档类型',
- 'type' => 'string',
- 'example' => 'text',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Tags' => [
- 'description' => '标签。',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'SearchSourceType' => [
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSource' => [
- 'description' => '数据集唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceName' => [
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Score' => [
- 'description' => '阈值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
- ],
- 'ChunkInfos' => [
- 'description' => '仅document 模式返回:文章维度相关chunk列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '片段',
- 'type' => 'object',
- 'properties' => [
- 'Chunk' => [
- 'description' => '片段',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Score' => [
- 'description' => '阈值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.77',
- ],
- ],
- ],
- ],
- 'Chunk' => [
- 'description' => '仅chunk 模式返回:片段',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'Success'],
+ 'ErrorMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'xxx'],
+ 'Event' => ['description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'SessionId' => ['description' => '会话ID。', 'type' => 'string', 'example' => '1a3d7c9f-3a6d-4e49-b176-2d8721a27397'],
+ 'StatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '8996314ce5514867943c71935e6a45af'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0bc1ec3a17435601877224179ecc8a'],
+ ],
+ ],
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => '输出内容', 'type' => 'string', 'example' => '文本生成结果'],
],
],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'string', 'example' => '200'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'success'],
+ 'Message' => ['description' => '信息', 'type' => 'string', 'example' => 'successful'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Documents\\": [\\n {\\n \\"DocUuid\\": \\"xxx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Title\\": \\"xx\\",\\n \\"PubTime\\": \\"2024-12-09 17:09:40\\",\\n \\"SourceFrom\\": \\"来源\\",\\n \\"DocId\\": \\"xx\\",\\n \\"DocType\\": \\"text\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Score\\": 0.5,\\n \\"ChunkInfos\\": [\\n {\\n \\"Chunk\\": \\"xx\\",\\n \\"Score\\": 0.77\\n }\\n ],\\n \\"Chunk\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-搜索文档',
- ],
- 'DeleteDatasetDocument' => [
- 'summary' => '删除数据源文档。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '生成PPT大纲内容',
+ 'summary' => '生成PPT大纲内容',
+ 'description' => '接入说明:'."\n"
+ ."\n"
+ .'- 当前接口为 HTTP-SSE 协议。'."\n"
+ .'- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持Java、Python版本的 sdk)请参考[PPT生成最佳实践文档](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices)。'."\n"
+ .'- 其中获取 Java 异步 SDK 的最新版本: [请点击链接获取](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?spm=a2c4g.11186623.0.0.4cd3170d7rccDC&version=2023-08-01&language=java-async-tea&tab=primer-doc)。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunPptOutlineGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Event\\": \\"task-started\\",\\n \\"SessionId\\": \\"1a3d7c9f-3a6d-4e49-b176-2d8721a27397\\",\\n \\"StatusCode\\": 200,\\n \\"TaskId\\": \\"8996314ce5514867943c71935e6a45af\\",\\n \\"TraceId\\": \\"0bc1ec3a17435601877224179ecc8a\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\"\\n }\\n },\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'RunQuickWriting' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'DatasetId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '数据集唯一标识',
- 'description' => '数据集唯一标识:和DatasetName二选一必选',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'schema' => ['title' => '任务ID,多轮对话可复用同一轮任务ID', 'description' => '任务ID,多轮对话可复用同一轮任务ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'DatasetName',
+ 'name' => 'Articles',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '数据集名称',
- 'description' => '数据集名称',
- 'type' => 'string',
+ 'title' => '引用的文章',
+ 'description' => '引用的文章',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '文章对象',
+ 'description' => '文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['title' => '文章标题', 'description' => '文章标题', 'type' => 'string', 'required' => false, 'example' => '文章标题'],
+ 'Content' => ['title' => '文章内容', 'description' => '文章内容', 'type' => 'string', 'required' => false, 'example' => '文章内容'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'],
+ ],
+ 'required' => false,
+ 'example' => '文章对象'."\n",
+ ],
'required' => false,
- 'example' => '数据集名称',
+ 'example' => '集合',
],
],
[
- 'name' => 'DocId',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户指定的文档唯一ID',
- 'description' => '用户指定的文档唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '其他写作参数(prompt 和 writingParams 二选一)', 'description' => '其他写作参数(prompt 和 writingParams 二选一)', 'type' => 'string', 'required' => true, 'example' => '请按英文输出'],
],
[
- 'name' => 'DocUuid',
+ 'name' => 'SearchSources',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
+ 'title' => '使用指定的搜索源列表',
+ 'description' => '使用指定的搜索源列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '搜索源对象',
+ 'description' => '搜索源对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索', 'description' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch'],
+ 'DatasetName' => ['title' => '数据源唯一标识', 'description' => '数据源唯一标识', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'xxx',
],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'BaseLlmResponse',
+ 'description' => 'BaseLlmResponse',
'type' => 'object',
'properties' => [
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '删除文档唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
+ 'Header' => [
+ 'title' => '响应头',
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'StatusCode' => ['title' => 'http响应码', 'description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'title' => '输出',
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
+ ],
+ ],
+ 'Usage' => [
+ 'description' => 'Token用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '78'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '38'],
+ ],
+ ],
+ ],
],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'End' => ['description' => '响应包是否结束', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n \\"xxx\\"\\n ],\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '数据源-删除数据集文档',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '快速写作',
+ 'summary' => '可直接输入写作指令,进行快速写作。',
+ 'description' => '### 接入说明:'."\n"
+ .'- 由于OpenAPI门户目前对SSE推理协议不兼容(无法直接调试),接口SDK方式调用示例请参考[妙笔最佳实践](https://help.aliyun.com/zh/model-studio/best-practices-for-miaobi-api?spm=a2c4g.11186623.help-menu-2400256.d_1_12_6_2_1_0.39892421FntuI2&scm=20140722.H_2844289._.OR_help-T_cn~zh-V_1)文档。'."\n"
+ .'- 获取Java异步SDK的最新版本:请点击[链接](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?version=2023-08-01&language=java-async-tea&tab=primer-doc)获取。'."\n",
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunQuickWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 78,\\n \\"OutputTokens\\": 34,\\n \\"TotalTokens\\": 38\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": false\\n}","type":"json"}]',
],
'RunSearchGeneration' => [
- 'summary' => 'AI妙搜-智能搜索生成:对应妙搜首页的搜索生成能力。此接口支持通用搜索和媒资搜索。支持用户问题澄清、多模态知识搜索、多agent生成等能力。'."\n"
- .'- 通用搜索:可以对数据集中知识进行语义检索,并对搜索结果进行多agent后处理,包括总结生成、摘编、时间线总结等。'."\n"
- .'- 媒资搜索:应搜尽搜,全文检索,召回更多相关知识,并可进行多agent后处理,包括聚类、新闻抽取等。',
'path' => '/quanmiao/aimiaosou/runSearchGeneration',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -33022,57 +20892,29 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'title' => '搜索任务唯一标识',
- 'description' => '会话任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
- ],
+ 'schema' => ['title' => '搜索任务唯一标识', 'description' => '会话任务唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'],
],
[
'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '搜索query',
- 'description' => '搜索词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '杭州亚运会吉祥物是什么',
- ],
+ 'schema' => ['title' => '搜索query', 'description' => '搜索词', 'type' => 'string', 'required' => false, 'example' => '杭州亚运会吉祥物是什么'],
],
[
'name' => 'OriginalSessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '原会话唯一标识:通常为空,非空时,表示当前对话基于此轮对话生成,会加载原始轮对话参数,搜索结果等,同时会替换生成结果,适用于,重新生成、修改数据源、新增agent生成场景',
- 'description' => '原会话唯一标识:通常为空,非空时,表示当前对话基于此轮对话生成,会加载原始轮对话参数,搜索结果等,同时会替换生成结果,适用于,重新生成、修改数据源、新增agent生成场景',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
+ 'schema' => ['title' => '原会话唯一标识:通常为空,非空时,表示当前对话基于此轮对话生成,会加载原始轮对话参数,搜索结果等,同时会替换生成结果,适用于,重新生成、修改数据源、新增agent生成场景', 'description' => '原会话唯一标识:通常为空,非空时,表示当前对话基于此轮对话生成,会加载原始轮对话参数,搜索结果等,同时会替换生成结果,适用于,重新生成、修改数据源、新增agent生成场景', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
'name' => 'ChatConfig',
@@ -33090,10 +20932,7 @@
.'- copilotPrecise:纯搜索',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'copilotPrecise' => 'copilotPrecise',
- 'copilotReference' => 'copilotReference',
- ],
+ 'enumValueTitles' => ['copilotPrecise' => 'copilotPrecise', 'copilotReference' => 'copilotReference'],
'example' => 'copilotReference',
],
'SearchParam' => [
@@ -33101,22 +20940,8 @@
'description' => '搜索参数',
'type' => 'object',
'properties' => [
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1725983999999',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1725983999999',
- ],
+ 'StartTime' => ['title' => '开始时间', 'description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1725983999999'],
+ 'EndTime' => ['title' => '结束时间', 'description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1725983999999'],
'SearchSources' => [
'title' => '搜索源列表',
'description' => '搜索源列表',
@@ -33140,20 +20965,10 @@
.'- ThirdSearch:三方API搜索',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'SystemSearch' => 'SystemSearch',
- 'ThirdSearch' => 'ThirdSearch',
- 'CustomSemanticSearch' => 'CustomSemanticSearch',
- ],
+ 'enumValueTitles' => ['SystemSearch' => 'SystemSearch', 'ThirdSearch' => 'ThirdSearch', 'CustomSemanticSearch' => 'CustomSemanticSearch'],
'example' => 'SystemSearch',
],
- 'DatasetName' => [
- 'title' => '数据源唯一标识:对应数据集datasetName',
- 'description' => '搜索源唯一标识:对应页面数据集名称,比如 4cb0eda3fad841758262dbe8d61191',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
- ],
+ 'DatasetName' => ['title' => '数据源唯一标识:对应数据集datasetName', 'description' => '搜索源唯一标识:对应页面数据集名称,比如 4cb0eda3fad841758262dbe8d61191', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
],
'required' => false,
],
@@ -33171,121 +20986,42 @@
.'- video:视频',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'image' => 'image',
- 'text' => 'text',
- 'video' => 'video',
- ],
+ 'enumValueTitles' => ['image' => 'image', 'text' => 'text', 'video' => 'video'],
'example' => 'text',
],
'required' => false,
],
- 'SearchTextMinScore' => [
- 'title' => '文本搜索阈值',
- 'description' => '文本搜索阈值:仅自建数据源(0, 1)',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.66',
- ],
- 'SearchImageMinScore' => [
- 'title' => '图片搜索阈值',
- 'description' => '图片搜索阈值:仅自建数据源(0, 1)',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.66',
- ],
- 'SearchVideoMinScore' => [
- 'title' => '视频搜索阈值',
- 'description' => '视频搜索阈值:仅自建数据源(0, 1)',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.66',
- ],
- 'SearchAudioMinScore' => [
- 'title' => '语音搜索阈值',
- 'description' => '语音搜索阈值:仅自建数据源(0, 1)',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.66',
- ],
+ 'SearchTextMinScore' => ['title' => '文本搜索阈值', 'description' => '文本搜索阈值:仅自建数据源(0, 1)', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.66'],
+ 'SearchImageMinScore' => ['title' => '图片搜索阈值', 'description' => '图片搜索阈值:仅自建数据源(0, 1)', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.66'],
+ 'SearchVideoMinScore' => ['title' => '视频搜索阈值', 'description' => '视频搜索阈值:仅自建数据源(0, 1)', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.66'],
+ 'SearchAudioMinScore' => ['title' => '语音搜索阈值', 'description' => '语音搜索阈值:仅自建数据源(0, 1)', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.66'],
'CategoryUuids' => [
'description' => '类目唯一标识',
'type' => 'array',
- 'items' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
],
'Tags' => [
'description' => '标签',
'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
+ 'items' => ['description' => '标签', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
- 'example' => 'xxx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'CreateTimeStart' => [
- 'description' => '起始创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111111111111',
- ],
- 'CreateTimeEnd' => [
- 'description' => '截止创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111111111111',
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'CreateTimeStart' => ['description' => '起始创建时间,时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111111111111'],
+ 'CreateTimeEnd' => ['description' => '截止创建时间,时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111111111111'],
'DocIds' => [
'description' => '文档ID数组',
'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'x',
- ],
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => 'x'],
'required' => false,
],
'DocUuids' => [
'description' => '文档唯一标识',
'type' => 'array',
- 'items' => [
- 'description' => '文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'x',
- ],
+ 'items' => ['description' => '文档唯一标识', 'type' => 'string', 'required' => false, 'example' => 'x'],
'required' => false,
],
],
@@ -33305,13 +21041,7 @@
.'- ExtractNewsElementGenerate:抽取新闻要素',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'TextGenerate' => 'TextGenerate',
- 'ExtractNewsElementGenerate' => 'ExtractNewsElementGenerate',
- 'ClusterGenerate' => 'ClusterGenerate',
- 'TimelineGenerate' => 'TimelineGenerate',
- 'ExcerptGenerate' => 'ExcerptGenerate',
- ],
+ 'enumValueTitles' => ['TextGenerate' => 'TextGenerate', 'ExtractNewsElementGenerate' => 'ExtractNewsElementGenerate', 'ClusterGenerate' => 'ClusterGenerate', 'TimelineGenerate' => 'TimelineGenerate', 'ExcerptGenerate' => 'ExcerptGenerate'],
'example' => 'TextGenerate',
],
'required' => false,
@@ -33325,124 +21055,98 @@
.'- deepResearch:研究',
'type' => 'string',
'required' => false,
- 'enumValueTitles' => [
- 'concise' => 'concise',
- 'enhance' => 'enhance',
- ],
+ 'enumValueTitles' => ['concise' => 'concise', 'enhance' => 'enhance'],
'example' => 'concise',
],
- 'EnableThinking' => [
- 'title' => '是否思考模式,默认:否',
- 'description' => '是否开启思考',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
+ 'EnableThinking' => ['title' => '是否思考模式,默认:否', 'description' => '是否开启思考', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
'ExcludeGenerateOptions' => [
'title' => '跳过的生成选项:think(思考)、multimodalSearchThink(多模态搜索思考)、queryRecommend(query推荐)',
'description' => '跳过的生成选项列表',
'type' => 'array',
- 'items' => [
- 'description' => '跳过的生成选项'."\n"
- .'- think(query改写)'."\n"
- .'- multimodalSearchThink(多模态搜索思考)'."\n"
- .'- queryRecommend(query推荐)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'think',
- ],
- 'required' => false,
- ],
- 'ModelCustomPromptTemplate' => [
- 'title' => '问答式搜索-总结生成答案-纯文本prompt模版,比如:必须包含变量 query、content',
- 'description' => '问答式搜索-总结生成答案-纯文本prompt模版,必须包含变量 query、content,比如:'."\n"
- .'```text'."\n"
- .'# 角色'."\n"
- .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
- ."\n"
- .'# 任务目标'."\n"
- .'请你根据检索到的相关文章,回答或表述用户问题“{query}”。'."\n"
- ."\n"
- .'# 任务限制'."\n"
- .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
- .'- 生成内容结构条理。'."\n"
- .'- 生成内容尽量精简。'."\n"
- .'- 不要使用其他数据,不要杜撰。'."\n"
- .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
- .' - 中文:"根据已知信息无法回答。"'."\n"
- .' - 英文:"Unable to answer based on the known information."'."\n"
- ."\n"
- .'# 输入数据'."\n"
- .'## 检索到的相关文章'."\n"
- .'{content}'."\n"
- .'```',
- 'type' => 'string',
+ 'items' => ['description' => '跳过的生成选项'."\n"
+ .'- think(query改写)'."\n"
+ .'- multimodalSearchThink(多模态搜索思考)'."\n"
+ .'- queryRecommend(query推荐)', 'type' => 'string', 'required' => false, 'example' => 'think'],
'required' => false,
- 'example' => '# 角色'."\n"
- .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
- ."\n"
- .'# 任务目标'."\n"
- .'请你根据检索到的相关文章,回答或表述用户问题“{query}”。'."\n"
- ."\n"
- .'# 任务限制'."\n"
- .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
- .'- 生成内容结构条理。'."\n"
- .'- 生成内容尽量精简。'."\n"
- .'- 不要使用其他数据,不要杜撰。'."\n"
- .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
- .' - 中文:"根据已知信息无法回答。"'."\n"
- .' - 英文:"Unable to answer based on the known information."'."\n"
- ."\n"
- .'# 输入数据'."\n"
- .'## 检索到的相关文章'."\n"
- .'{content}',
- ],
- 'ModelCustomVlPromptTemplate' => [
- 'title' => '问答式搜索-总结生成答案-文本&图片prompt模版,比如:必须包含变量 query、content',
- 'description' => '问答式搜索-总结生成答案-纯文本prompt模版,必须包含变量 query、content,比如:'."\n"
- .'```text'."\n"
- .'# 角色'."\n"
- .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
- ."\n"
- .'# 任务目标'."\n"
- .'请你根据检索到的相关文章和图片,回答或表述用户问题“{query}”。'."\n"
- ."\n"
- .'# 任务限制'."\n"
- .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
- .'- 生成内容结构条理。'."\n"
- .'- 生成内容尽量精简。'."\n"
- .'- 如果图片内容可以回答,可以忽略文章内容。'."\n"
- .'- 不要使用其他数据,不要杜撰。'."\n"
- .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
- .' - 中文:"根据已知信息无法回答。"'."\n"
- .' - 英文:"Unable to answer based on the known information."'."\n"
- ."\n"
- .'# 输入数据'."\n"
- .'## 检索到的相关文章'."\n"
- .'{content}'."\n"
- .'```',
- 'type' => 'string',
- 'required' => false,
- 'example' => '# 角色'."\n"
- .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
- ."\n"
- .'# 任务目标'."\n"
- .'请你根据检索到的相关文章和图片,回答或表述用户问题“{query}”。'."\n"
- ."\n"
- .'# 任务限制'."\n"
- .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
- .'- 生成内容结构条理。'."\n"
- .'- 生成内容尽量精简。'."\n"
- .'- 如果图片内容可以回答,可以忽略文章内容。'."\n"
- .'- 不要使用其他数据,不要杜撰。'."\n"
- .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
- .' - 中文:"根据已知信息无法回答。"'."\n"
- .' - 英文:"Unable to answer based on the known information."'."\n"
- ."\n"
- .'# 输入数据'."\n"
- .'## 检索到的相关文章'."\n"
- .'{content}'."\n",
],
+ 'ModelCustomPromptTemplate' => ['title' => '问答式搜索-总结生成答案-纯文本prompt模版,比如:必须包含变量 query、content', 'description' => '问答式搜索-总结生成答案-纯文本prompt模版,必须包含变量 query、content,比如:'."\n"
+ .'```text'."\n"
+ .'# 角色'."\n"
+ .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
+ ."\n"
+ .'# 任务目标'."\n"
+ .'请你根据检索到的相关文章,回答或表述用户问题“{query}”。'."\n"
+ ."\n"
+ .'# 任务限制'."\n"
+ .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
+ .'- 生成内容结构条理。'."\n"
+ .'- 生成内容尽量精简。'."\n"
+ .'- 不要使用其他数据,不要杜撰。'."\n"
+ .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
+ .' - 中文:"根据已知信息无法回答。"'."\n"
+ .' - 英文:"Unable to answer based on the known information."'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 检索到的相关文章'."\n"
+ .'{content}'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => '# 角色'."\n"
+ .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
+ ."\n"
+ .'# 任务目标'."\n"
+ .'请你根据检索到的相关文章,回答或表述用户问题“{query}”。'."\n"
+ ."\n"
+ .'# 任务限制'."\n"
+ .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
+ .'- 生成内容结构条理。'."\n"
+ .'- 生成内容尽量精简。'."\n"
+ .'- 不要使用其他数据,不要杜撰。'."\n"
+ .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
+ .' - 中文:"根据已知信息无法回答。"'."\n"
+ .' - 英文:"Unable to answer based on the known information."'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 检索到的相关文章'."\n"
+ .'{content}'],
+ 'ModelCustomVlPromptTemplate' => ['title' => '问答式搜索-总结生成答案-文本&图片prompt模版,比如:必须包含变量 query、content', 'description' => '问答式搜索-总结生成答案-纯文本prompt模版,必须包含变量 query、content,比如:'."\n"
+ .'```text'."\n"
+ .'# 角色'."\n"
+ .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
+ ."\n"
+ .'# 任务目标'."\n"
+ .'请你根据检索到的相关文章和图片,回答或表述用户问题“{query}”。'."\n"
+ ."\n"
+ .'# 任务限制'."\n"
+ .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
+ .'- 生成内容结构条理。'."\n"
+ .'- 生成内容尽量精简。'."\n"
+ .'- 如果图片内容可以回答,可以忽略文章内容。'."\n"
+ .'- 不要使用其他数据,不要杜撰。'."\n"
+ .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
+ .' - 中文:"根据已知信息无法回答。"'."\n"
+ .' - 英文:"Unable to answer based on the known information."'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 检索到的相关文章'."\n"
+ .'{content}'."\n"
+ .'```', 'type' => 'string', 'required' => false, 'example' => '# 角色'."\n"
+ .'你是一个专业的文章检索和问答专家,擅长文章检索和回答用户问题。'."\n"
+ ."\n"
+ .'# 任务目标'."\n"
+ .'请你根据检索到的相关文章和图片,回答或表述用户问题“{query}”。'."\n"
+ ."\n"
+ .'# 任务限制'."\n"
+ .'- 如果用户问题中提到具体日期,请考虑知识日期做筛选。'."\n"
+ .'- 生成内容结构条理。'."\n"
+ .'- 生成内容尽量精简。'."\n"
+ .'- 如果图片内容可以回答,可以忽略文章内容。'."\n"
+ .'- 不要使用其他数据,不要杜撰。'."\n"
+ .'- 如果不能回答用户问题,请输出对应语言的拒识文案:'."\n"
+ .' - 中文:"根据已知信息无法回答。"'."\n"
+ .' - 英文:"Unable to answer based on the known information."'."\n"
+ ."\n"
+ .'# 输入数据'."\n"
+ .'## 检索到的相关文章'."\n"
+ .'{content}'."\n"],
],
'required' => false,
'example' => 'xxx',
@@ -33467,41 +21171,11 @@
'description' => '用户输入或选中的多模态数据',
'type' => 'object',
'properties' => [
- 'SelectionType' => [
- 'title' => '参照数据来源类型,取值范围: ‒ 全量的:all,历史会话中取全量数据,仅支持聚类场景; ‒ 选中的:selected,生成时,会取textSearchResult中数据;',
- 'description' => '参照数据来源类型,取值范围: ‒ 全量的:all,历史会话中取全量数据,仅支持聚类场景; ‒ 选中的:selected,生成时,会取textSearchResult中数据;',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'all',
- ],
- 'SessionId' => [
- 'title' => '生成参照会话唯一标识:搜索生成时当前对话下取数据,比如聚类,目前仅媒资搜索场景-聚类需要',
- 'description' => '生成参照会话唯一标识:搜索生成时当前对话下取数据,比如聚类,目前仅媒资搜索场景-聚类需要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'OriginalSessionId' => [
- 'title' => '原始会话唯一标识:搜索结果取这个会话中的全量,目前仅媒资搜索场景需要',
- 'description' => '原始会话唯一标识:搜索结果取这个会话中的全量,目前仅媒资搜索场景需要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '原始会话唯一标识:搜索结果取这个会话中的全量,目前仅媒资搜索场景需要',
- ],
- 'SearchModel' => [
- 'title' => '仅聚类,对聚类子类内容二次聚类时传入,ClusterGenerate',
- 'description' => '仅聚类,对聚类子类内容二次聚类时传入,ClusterGenerate',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TextGenerate',
- ],
- 'SearchModelDataValue' => [
- 'title' => 'searchModel=ClusterGenerate时,取子类topic名称,注意如果原值有引号时也要带上',
- 'description' => 'searchModel=ClusterGenerate时,取子类topic名称,注意如果原值有引号时也要带上',
- 'type' => 'string',
- 'required' => false,
- 'example' => '分类1',
- ],
+ 'SelectionType' => ['title' => '参照数据来源类型,取值范围: ‒ 全量的:all,历史会话中取全量数据,仅支持聚类场景; ‒ 选中的:selected,生成时,会取textSearchResult中数据;', 'description' => '参照数据来源类型,取值范围: ‒ 全量的:all,历史会话中取全量数据,仅支持聚类场景; ‒ 选中的:selected,生成时,会取textSearchResult中数据;', 'type' => 'string', 'required' => false, 'example' => 'all'],
+ 'SessionId' => ['title' => '生成参照会话唯一标识:搜索生成时当前对话下取数据,比如聚类,目前仅媒资搜索场景-聚类需要', 'description' => '生成参照会话唯一标识:搜索生成时当前对话下取数据,比如聚类,目前仅媒资搜索场景-聚类需要', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'OriginalSessionId' => ['title' => '原始会话唯一标识:搜索结果取这个会话中的全量,目前仅媒资搜索场景需要', 'description' => '原始会话唯一标识:搜索结果取这个会话中的全量,目前仅媒资搜索场景需要', 'type' => 'string', 'required' => false, 'example' => '原始会话唯一标识:搜索结果取这个会话中的全量,目前仅媒资搜索场景需要'],
+ 'SearchModel' => ['title' => '仅聚类,对聚类子类内容二次聚类时传入,ClusterGenerate', 'description' => '仅聚类,对聚类子类内容二次聚类时传入,ClusterGenerate', 'type' => 'string', 'required' => false, 'example' => 'TextGenerate'],
+ 'SearchModelDataValue' => ['title' => 'searchModel=ClusterGenerate时,取子类topic名称,注意如果原值有引号时也要带上', 'description' => 'searchModel=ClusterGenerate时,取子类topic名称,注意如果原值有引号时也要带上', 'type' => 'string', 'required' => false, 'example' => '分类1'],
'TextSearchResult' => [
'title' => '文本搜索结果',
'description' => '文本搜索结果',
@@ -33515,103 +21189,25 @@
'description' => '文本搜索结果',
'type' => 'object',
'properties' => [
- 'SearchSourceType' => [
- 'title' => '搜索信源类型,同searchSource.code',
- 'description' => '搜索信源类型,同searchSource.code',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '搜索信源唯一标识,同searchSource.datasetName',
- 'description' => '搜索信源唯一标识,同searchSource.datasetName',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2024-11-25 14:25:59',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => '新华社',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章标题',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章内容',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文章摘要',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- 'Score' => [
- 'title' => '相关度',
- 'description' => '相关度',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '1',
- ],
+ 'SearchSourceType' => ['title' => '搜索信源类型,同searchSource.code', 'description' => '搜索信源类型,同searchSource.code', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '搜索信源唯一标识,同searchSource.datasetName', 'description' => '搜索信源唯一标识,同searchSource.datasetName', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'required' => false, 'example' => '互联网搜索'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'required' => false, 'example' => '2024-11-25 14:25:59'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'required' => false, 'example' => '新华社'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '文章标题'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '文章内容'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'required' => false, 'example' => '文章摘要'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Score' => ['title' => '相关度', 'description' => '相关度', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '1'],
'Chunks' => [
'title' => '相关chunk',
'description' => '相关chunk',
'type' => 'array',
- 'items' => [
- 'description' => '片段',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
+ 'items' => ['description' => '片段', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
- 'example' => '文档-自定义的唯一ID',
],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'required' => false, 'example' => '文档-自定义的唯一ID'],
],
'required' => false,
],
@@ -33623,80 +21219,27 @@
],
'required' => false,
],
- 'SkipCurrentSupplement' => [
- 'description' => '是否跳过反问',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'false',
- ],
- 'AskUser' => [
- 'title' => '反问',
- 'description' => '反问',
- 'type' => 'string',
- 'required' => false,
- 'example' => '您想了解关于xx的哪些信息?',
- ],
+ 'SkipCurrentSupplement' => ['description' => '是否跳过反问', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ 'AskUser' => ['title' => '反问', 'description' => '反问', 'type' => 'string', 'required' => false, 'example' => '您想了解关于xx的哪些信息?'],
'AskUserKeywords' => [
'title' => '反问关键词列表',
'description' => '反问推荐关键词列表',
'type' => 'array',
- 'items' => [
- 'title' => '反问关键词',
- 'description' => '反问推荐关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'UserBack' => [
- 'title' => '用户针对反问问题的反馈',
- 'description' => '反问用户反馈',
- 'type' => 'string',
+ 'items' => ['title' => '反问关键词', 'description' => '反问推荐关键词', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
- 'example' => '地点',
],
+ 'UserBack' => ['title' => '用户针对反问问题的反馈', 'description' => '反问用户反馈', 'type' => 'string', 'required' => false, 'example' => '地点'],
'UserBackKeywords' => [
'title' => '用户针对反问问题推荐关键词的反馈列表',
'description' => '反问用户反馈关键词列表',
'type' => 'array',
- 'items' => [
- 'title' => '用户针对反问问题推荐关键词的反馈',
- 'description' => '反问用户反馈关键词',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'CurrentStep' => [
- 'title' => '当前步骤',
- 'description' => '当前步骤',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'think',
- ],
- 'NextStep' => [
- 'title' => '下一步',
- 'description' => '下一步',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'generate',
- ],
- 'SupplementDataType' => [
- 'title' => '补充数据类型',
- 'description' => '思考-需要补充的数据类型:searchQuery',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'searchQuery',
- ],
- 'SupplementEnable' => [
- 'title' => '是否补充',
- 'description' => '思考-是否需要补充',
- 'type' => 'boolean',
+ 'items' => ['title' => '用户针对反问问题推荐关键词的反馈', 'description' => '反问用户反馈关键词', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
- 'example' => 'true',
],
+ 'CurrentStep' => ['title' => '当前步骤', 'description' => '当前步骤', 'type' => 'string', 'required' => false, 'example' => 'think'],
+ 'NextStep' => ['title' => '下一步', 'description' => '下一步', 'type' => 'string', 'required' => false, 'example' => 'generate'],
+ 'SupplementDataType' => ['title' => '补充数据类型', 'description' => '思考-需要补充的数据类型:searchQuery', 'type' => 'string', 'required' => false, 'example' => 'searchQuery'],
+ 'SupplementEnable' => ['title' => '是否补充', 'description' => '思考-是否需要补充', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
],
@@ -33707,31 +21250,18 @@
[
'name' => 'ModelId',
'in' => 'formData',
- 'schema' => [
- 'title' => '模型id',
- 'description' => '模型id:'."\n"
- .'- quanmiao-max:全妙-Max'."\n"
- .'- quanmiao-plus:全妙-Plus',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max',
- ],
+ 'schema' => ['title' => '模型id', 'description' => '模型id:'."\n"
+ .'- quanmiao-max:全妙-Max'."\n"
+ .'- quanmiao-plus:全妙-Plus', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max'],
],
[
'name' => 'FileUrl',
'in' => 'formData',
- 'schema' => [
- 'title' => '图片url',
- 'description' => '图片url:适用于图搜、图文(prompt)混合搜索生成等场景',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxxx',
- ],
+ 'schema' => ['title' => '图片url', 'description' => '图片url:适用于图搜、图文(prompt)混合搜索生成等场景', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => '响应结果',
'description' => 'Schema of Response',
@@ -33757,18 +21287,8 @@
'description' => '业务上下文',
'type' => 'object',
'properties' => [
- 'CurrentStep' => [
- 'title' => '当前步骤 (start, interveneCheck: 干预, securityCheck: 绿网, think: 思考, queryRealize: query理解, userInteraction: 用户追问, search: 文本搜索, searchResult: 文本搜索结果, multimodalSearch: 多模态搜索, generate: 生成, searchGenerate: 搜索生成, queryRecommend: 推荐, generateReference: 引用, generateTraceability: 溯源, generateIllustration: 配图, end)',
- 'description' => '任务当前操作步数。',
- 'type' => 'string',
- 'example' => 'start',
- ],
- 'NextStep' => [
- 'title' => '下一步 (start, interveneCheck: 干预, securityCheck: 绿网, think: 思考, queryRealize: query理解, userInteraction: 用户追问, search: 文本搜索, searchResult: 文本搜索结果, multimodalSearch: 多模态搜索, generate: 生成, searchGenerate: 搜索生成, queryRecommend: 推荐, generateReference: 引用, generateTraceability: 溯源, generateIllustration: 配图, end)',
- 'description' => '下一步:think、search、generat',
- 'type' => 'string',
- 'example' => 'search',
- ],
+ 'CurrentStep' => ['title' => '当前步骤 (start, interveneCheck: 干预, securityCheck: 绿网, think: 思考, queryRealize: query理解, userInteraction: 用户追问, search: 文本搜索, searchResult: 文本搜索结果, multimodalSearch: 多模态搜索, generate: 生成, searchGenerate: 搜索生成, queryRecommend: 推荐, generateReference: 引用, generateTraceability: 溯源, generateIllustration: 配图, end)', 'description' => '任务当前操作步数。', 'type' => 'string', 'example' => 'start'],
+ 'NextStep' => ['title' => '下一步 (start, interveneCheck: 干预, securityCheck: 绿网, think: 思考, queryRealize: query理解, userInteraction: 用户追问, search: 文本搜索, searchResult: 文本搜索结果, multimodalSearch: 多模态搜索, generate: 生成, searchGenerate: 搜索生成, queryRecommend: 推荐, generateReference: 引用, generateTraceability: 溯源, generateIllustration: 配图, end)', 'description' => '下一步:think、search、generat', 'type' => 'string', 'example' => 'search'],
'GeneratedContent' => [
'description' => '生成内容',
'type' => 'object',
@@ -33785,12 +21305,7 @@
'description' => '聚类',
'type' => 'object',
'properties' => [
- 'Topic' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'Topic' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'example' => 'xx'],
'ImageSearchResult' => [
'title' => '图片搜索结果',
'description' => '图片搜索结果',
@@ -33808,119 +21323,33 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签。',
'type' => 'array',
- 'items' => [
- 'description' => '标签。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceType' => [
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSource' => [
- 'description' => '数据集唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签。', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceType' => ['description' => '数据集类型', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSource' => ['description' => '数据集唯一标识', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'Current' => [
- 'title' => '当前页',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '每页条数',
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Current' => ['title' => '当前页', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '每页条数', 'description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['title' => '总条数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'TextSearchResult' => [
@@ -33936,60 +21365,15 @@
'description' => '搜索结果',
'type' => 'object',
'properties' => [
- 'SearchSourceType' => [
- 'title' => '搜索信源类型,同searchSource.code',
- 'description' => '搜索信源类型,同searchSource.code',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '搜索信源唯一标识,同searchSource.datasetName',
- 'description' => '搜索信源唯一标识,同searchSource.datasetName',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-04-04 08:39:09',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceType' => ['title' => '搜索信源类型,同searchSource.code', 'description' => '搜索信源类型,同searchSource.code', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '搜索信源唯一标识,同searchSource.datasetName', 'description' => '搜索信源唯一标识,同searchSource.datasetName', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-04-04 08:39:09'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
'MultimodalMedias' => [
'description' => '多模态信息列表',
'type' => 'array',
@@ -33997,82 +21381,29 @@
'description' => '多模态信息',
'type' => 'object',
'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值:'."\n"
- .'- video:视频。'."\n"
- .'- image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值:'."\n"
+ .'- video:视频。'."\n"
+ .'- image:图片。', 'type' => 'string', 'example' => 'image'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签',
'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'Current' => [
- 'title' => '当前页',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '每页条数',
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Current' => ['title' => '当前页', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '每页条数', 'description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['title' => '总条数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'VideoSearchResult' => [
@@ -34092,89 +21423,26 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签',
'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'x',
- ],
- 'SearchSourceType' => [
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSource' => [
- 'description' => '数据集唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'x'],
+ 'SearchSourceType' => ['description' => '数据集类型', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSource' => ['description' => '数据集唯一标识', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
'ClipInfos' => [
'title' => '匹配信息',
'description' => '匹配信息列表',
@@ -34183,72 +21451,21 @@
'description' => '匹配信息',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'title' => '相关度阈值',
- 'description' => '参考置信度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
- 'From' => [
- 'title' => '开始位置',
- 'description' => '开始时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'To' => [
- 'title' => '开始位置',
- 'description' => '结束时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'Text' => [
- 'title' => '如果是asr,那就是asr转写结果',
- 'description' => '对应文本,比如asr转写结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Type' => [
- 'title' => '默认空',
- 'description' => '文本类型:比如asr',
- 'type' => 'string',
- 'example' => 'asr',
- ],
+ 'Score' => ['title' => '相关度阈值', 'description' => '参考置信度', 'type' => 'number', 'format' => 'double', 'example' => '0.9'],
+ 'From' => ['title' => '开始位置', 'description' => '开始时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'To' => ['title' => '开始位置', 'description' => '结束时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'Text' => ['title' => '如果是asr,那就是asr转写结果', 'description' => '对应文本,比如asr转写结果', 'type' => 'string', 'example' => 'xx'],
+ 'Type' => ['title' => '默认空', 'description' => '文本类型:比如asr', 'type' => 'string', 'example' => 'asr'],
],
],
],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'Current' => [
- 'title' => '当前页',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '每页条数',
- 'description' => '每页记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Current' => ['title' => '当前页', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '每页条数', 'description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['title' => '总条数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'AudioSearchResult' => [
@@ -34261,18 +21478,8 @@
'description' => '语音结果',
'type' => 'object',
'properties' => [
- 'FileUrl' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
- 'MediaId' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
+ 'FileUrl' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'http://xx'],
+ 'MediaId' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => 'xxx'],
'ClipInfos' => [
'title' => '匹配信息列表',
'description' => '匹配信息列表',
@@ -34282,39 +21489,11 @@
'description' => '匹配信息',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'title' => '阈值',
- 'description' => '阈值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'From' => [
- 'title' => '开始位置',
- 'description' => '开始位置',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'To' => [
- 'title' => '结束位置',
- 'description' => '结束位置',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'Text' => [
- 'title' => '文本内容',
- 'description' => '文本内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Type' => [
- 'title' => '类型',
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'asr',
- ],
+ 'Score' => ['title' => '阈值', 'description' => '阈值', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'From' => ['title' => '开始位置', 'description' => '开始位置', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'To' => ['title' => '结束位置', 'description' => '结束位置', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'Text' => ['title' => '文本内容', 'description' => '文本内容', 'type' => 'string', 'example' => 'xx'],
+ 'Type' => ['title' => '类型', 'description' => '类型', 'type' => 'string', 'example' => 'asr'],
],
],
],
@@ -34323,122 +21502,37 @@
'description' => '对应文档',
'type' => 'object',
'properties' => [
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'http://xx',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => 'docUuid',
- 'description' => 'docUuid',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => 'docId',
- 'description' => 'docId',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索源',
- 'description' => '搜索源',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'http://xx'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => 'docUuid', 'description' => 'docUuid', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => 'docId', 'description' => 'docId', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceName' => ['title' => '搜索源', 'description' => '搜索源', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceType' => [
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSource' => [
- 'description' => '数据集唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceType' => ['description' => '数据集类型', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSource' => ['description' => '数据集唯一标识', 'type' => 'string', 'example' => 'xx'],
],
],
],
],
- 'Current' => [
- 'title' => '当前页',
- 'description' => '当前页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '大小',
- 'description' => '大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'title' => '总数',
- 'description' => '总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Current' => ['title' => '当前页', 'description' => '当前页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '大小', 'description' => '大小', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
],
],
],
- 'TextGenerate' => [
- 'description' => '文本结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'GenerateFinished' => [
- 'title' => '是否生成完成',
- 'description' => '当前agent是否生成完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'TextGenerate' => ['description' => '文本结果', 'type' => 'string', 'example' => 'xx'],
+ 'GenerateFinished' => ['title' => '是否生成完成', 'description' => '当前agent是否生成完成', 'type' => 'boolean', 'example' => 'true'],
],
],
'ExcerptResult' => [
@@ -34446,12 +21540,7 @@
'description' => '原文语句回答结果',
'type' => 'object',
'properties' => [
- 'TextGenerate' => [
- 'title' => '文本生成结果',
- 'description' => '生成文本',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'TextGenerate' => ['title' => '文本生成结果', 'description' => '生成文本', 'type' => 'string', 'example' => 'xx'],
'SearchResult' => [
'title' => '文本搜索结果列表',
'description' => '搜索结果列表',
@@ -34460,102 +21549,26 @@
'description' => '搜索结果',
'type' => 'object',
'properties' => [
- 'TraceabilityId' => [
- 'title' => '溯源定位',
- 'description' => '溯源定位id',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SearchSourceType' => [
- 'title' => '搜索信源类型,同searchSource.code',
- 'description' => '搜索信源类型,同searchSource.code',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '搜索信源唯一标识,同searchSource.datasetName',
- 'description' => '搜索信源唯一标识,同searchSource.datasetName',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-04-04 08:39:09',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Excerpt' => [
- 'title' => '智搜:摘编结果',
- 'description' => '原文语句回答内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Select' => [
- 'title' => '参照与否',
- 'description' => '是否参照',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Score' => [
- 'title' => '相关度',
- 'description' => '置信度,仅供参考',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.99',
- ],
+ 'TraceabilityId' => ['title' => '溯源定位', 'description' => '溯源定位id', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SearchSourceType' => ['title' => '搜索信源类型,同searchSource.code', 'description' => '搜索信源类型,同searchSource.code', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '搜索信源唯一标识,同searchSource.datasetName', 'description' => '搜索信源唯一标识,同searchSource.datasetName', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-04-04 08:39:09'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Content' => ['title' => '内容', 'description' => '正文', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'Excerpt' => ['title' => '智搜:摘编结果', 'description' => '原文语句回答内容', 'type' => 'string', 'example' => 'xx'],
+ 'Select' => ['title' => '参照与否', 'description' => '是否参照', 'type' => 'boolean', 'example' => 'true'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Score' => ['title' => '相关度', 'description' => '置信度,仅供参考', 'type' => 'number', 'format' => 'float', 'example' => '0.99'],
'Chunks' => [
'title' => '相关chunk',
'description' => '片段列表',
'type' => 'array',
- 'items' => [
- 'description' => '片段',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '片段', 'type' => 'string', 'example' => 'xx'],
],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
'TextGenerateMultimodalMediaList' => [
'title' => '配图',
'description' => '配图列表',
@@ -34564,26 +21577,9 @@
'description' => '配图',
'type' => 'object',
'properties' => [
- 'Start' => [
- 'title' => '段落开始',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'End' => [
- 'title' => '段落结束',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'DocUuid' => [
- 'title' => '关联文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'Start' => ['title' => '段落开始', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'End' => ['title' => '段落结束', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'DocUuid' => ['title' => '关联文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
'MultimodalMediaList' => [
'title' => '段落溯源信息对应的多模态',
'description' => '多模态数据列表',
@@ -34597,58 +21593,18 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'DocId' => [
- 'title' => '文档业务唯一标识',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceName' => [
- 'title' => '文章来源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '文章标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章url',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'DocId' => ['title' => '文档业务唯一标识', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceName' => ['title' => '文章来源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '文章标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章url', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值:'."\n"
- .'video:视频。'."\n"
- .'image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值:'."\n"
+ .'video:视频。'."\n"
+ .'image:图片。', 'type' => 'string', 'example' => 'image'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -34662,81 +21618,31 @@
'description' => '多模态信息',
'type' => 'object',
'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值:'."\n"
- .'- video:视频。'."\n"
- .'- image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件 URL。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值:'."\n"
+ .'- video:视频。'."\n"
+ .'- image:图片。', 'type' => 'string', 'example' => 'image'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件 URL。', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
],
],
],
],
- 'GenerateFinished' => [
- 'title' => '是否生成完成',
- 'description' => '当前agent是否生成完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'GenerateLevel' => [
- 'title' => '生成等级',
- 'description' => '回答的详细程度:'."\n"
- .'- concise:简洁(默认)'."\n"
- .'- enhance:增强',
- 'type' => 'string',
- 'example' => 'concise',
- ],
- 'ReasonTextGenerate' => [
- 'title' => '深度思考内容',
- 'description' => '深度思考内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'GenerateFinished' => ['title' => '是否生成完成', 'description' => '当前agent是否生成完成', 'type' => 'boolean', 'example' => 'true'],
+ 'GenerateLevel' => ['title' => '生成等级', 'description' => '回答的详细程度:'."\n"
+ .'- concise:简洁(默认)'."\n"
+ .'- enhance:增强', 'type' => 'string', 'example' => 'concise'],
+ 'ReasonTextGenerate' => ['title' => '深度思考内容', 'description' => '深度思考内容', 'type' => 'string', 'example' => 'xx'],
],
],
'NewsElementResult' => [
@@ -34744,12 +21650,7 @@
'description' => '新闻抽取结果',
'type' => 'object',
'properties' => [
- 'TextGenerate' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成内容',
- 'type' => 'string',
- 'example' => 'x',
- ],
+ 'TextGenerate' => ['title' => '文本生成结果', 'description' => '文本生成内容', 'type' => 'string', 'example' => 'x'],
'NewsElementArticleList' => [
'title' => '新闻事件列表',
'description' => '新闻抽取列表',
@@ -34758,119 +21659,33 @@
'description' => '新闻抽取',
'type' => 'object',
'properties' => [
- 'TextGenerate' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'TextGenerate' => ['title' => '文本生成结果', 'description' => '文本生成内容', 'type' => 'string', 'example' => 'xx'],
'Article' => [
'title' => '文章信息',
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceType' => [
- 'title' => '搜索信源类型,同searchSource.code',
- 'description' => '搜索信源类型,同searchSource.code',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '搜索信源唯一标识,同searchSource.datasetName',
- 'description' => '搜索信源唯一标识,同searchSource.datasetName',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-04-04 08:39:09',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Select' => [
- 'title' => '参照与否',
- 'description' => '是否参照',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Score' => [
- 'title' => '相关度',
- 'description' => '置信度,仅供参考',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.99',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceType' => ['title' => '搜索信源类型,同searchSource.code', 'description' => '搜索信源类型,同searchSource.code', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '搜索信源唯一标识,同searchSource.datasetName', 'description' => '搜索信源唯一标识,同searchSource.datasetName', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-04-04 08:39:09'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Content' => ['title' => '内容', 'description' => '正文', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'Select' => ['title' => '参照与否', 'description' => '是否参照', 'type' => 'boolean', 'example' => 'true'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Score' => ['title' => '相关度', 'description' => '置信度,仅供参考', 'type' => 'number', 'format' => 'float', 'example' => '0.99'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
'NewsElementList' => [
@@ -34881,24 +21696,9 @@
'description' => '新闻',
'type' => 'object',
'properties' => [
- 'Time' => [
- 'title' => '时间',
- 'description' => '时间',
- 'type' => 'string',
- 'example' => '时间',
- ],
- 'Location' => [
- 'title' => '地点',
- 'description' => '地点',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'People' => [
- 'title' => '人物',
- 'description' => '人物',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'Time' => ['title' => '时间', 'description' => '时间', 'type' => 'string', 'example' => '时间'],
+ 'Location' => ['title' => '地点', 'description' => '地点', 'type' => 'string', 'example' => 'xx'],
+ 'People' => ['title' => '人物', 'description' => '人物', 'type' => 'string', 'example' => 'xx'],
'Event' => [
'title' => '时间详情',
'description' => '事件',
@@ -34908,31 +21708,19 @@
'title' => '引起原因',
'description' => '原因列表',
'type' => 'array',
- 'items' => [
- 'description' => '原因',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '原因', 'type' => 'string', 'example' => 'xx'],
],
'ProcessList' => [
'title' => '处理过程',
'description' => '经过列表',
'type' => 'array',
- 'items' => [
- 'description' => '经过',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '经过', 'type' => 'string', 'example' => 'xx'],
],
'ResultList' => [
'title' => '结果',
'description' => '结果列表',
'type' => 'array',
- 'items' => [
- 'description' => '结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '结果', 'type' => 'string', 'example' => 'xx'],
],
],
'example' => 'task-started',
@@ -34943,12 +21731,7 @@
],
],
],
- 'GenerateFinished' => [
- 'title' => '是否生成完成',
- 'description' => '当前agent是否生成完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'GenerateFinished' => ['title' => '是否生成完成', 'description' => '当前agent是否生成完成', 'type' => 'boolean', 'example' => 'true'],
],
],
'TextGenerateResult' => [
@@ -34956,12 +21739,7 @@
'description' => '总结生成答案',
'type' => 'object',
'properties' => [
- 'TextGenerate' => [
- 'title' => '文本生成结构',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'TextGenerate' => ['title' => '文本生成结构', 'description' => '文本生成结果', 'type' => 'string', 'example' => 'xx'],
'TextGenerateMultimodalMediaList' => [
'description' => '配图列表',
'type' => 'array',
@@ -34969,20 +21747,8 @@
'description' => '配图',
'type' => 'object',
'properties' => [
- 'Start' => [
- 'title' => '段落开始',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'End' => [
- 'title' => '段落结束',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Start' => ['title' => '段落开始', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'End' => ['title' => '段落结束', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MultimodalMediaList' => [
'title' => '段落溯源信息对应的多模态',
'description' => '多模态数据列表',
@@ -34996,62 +21762,17 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索源名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索源名称', 'type' => 'string', 'example' => 'xx'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '媒资ID。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值: video:视频。 image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '媒资ID。', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值: video:视频。 image:图片。', 'type' => 'string', 'example' => 'image'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -35066,131 +21787,35 @@
'description' => '参考文章',
'type' => 'object',
'properties' => [
- 'TraceabilityId' => [
- 'title' => '溯源定位',
- 'description' => '溯源定位id',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SearchSourceType' => [
- 'title' => '搜索信源类型,同searchSource.code',
- 'description' => '搜索信源类型,同searchSource.code',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '搜索信源唯一标识,同searchSource.datasetName',
- 'description' => '搜索信源唯一标识,同searchSource.datasetName',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-04-04 08:39:09',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '新华社',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Select' => [
- 'title' => '参照与否',
- 'description' => '是否参照',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Score' => [
- 'title' => '相关度',
- 'description' => '置信度,仅供参考',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.99',
- ],
+ 'TraceabilityId' => ['title' => '溯源定位', 'description' => '溯源定位id', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SearchSourceType' => ['title' => '搜索信源类型,同searchSource.code', 'description' => '搜索信源类型,同searchSource.code', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '搜索信源唯一标识,同searchSource.datasetName', 'description' => '搜索信源唯一标识,同searchSource.datasetName', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-04-04 08:39:09'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '新华社'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Content' => ['title' => '内容', 'description' => '正文', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'Select' => ['title' => '参照与否', 'description' => '是否参照', 'type' => 'boolean', 'example' => 'true'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Score' => ['title' => '相关度', 'description' => '置信度,仅供参考', 'type' => 'number', 'format' => 'float', 'example' => '0.99'],
'Chunks' => [
'title' => '相关chunk',
'description' => '片段列表',
'type' => 'array',
- 'items' => [
- 'description' => '片段',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '片段', 'type' => 'string', 'example' => 'xx'],
],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段 1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段 1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -35214,56 +21839,16 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索源名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索源名称', 'type' => 'string', 'example' => 'xx'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '媒资ID。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值: video:视频。 image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '媒资ID。', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值: video:视频。 image:图片。', 'type' => 'string', 'example' => 'image'],
'ClipInfos' => [
'title' => '匹配信息',
'description' => '匹配信息列表',
@@ -35272,90 +21857,24 @@
'description' => '匹配信息',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'title' => '相关度阈值',
- 'description' => '置信度,仅供参考',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.1',
- ],
- 'From' => [
- 'title' => '开始位置',
- 'description' => '开始时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'To' => [
- 'title' => '开始位置',
- 'description' => '结束时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'Text' => [
- 'title' => '如果是asr,那就是asr转写结果',
- 'description' => '对应文本,比如asr转写结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Type' => [
- 'title' => '默认空',
- 'description' => '类型:比如asr',
- 'type' => 'string',
- 'example' => 'asr',
- ],
+ 'Score' => ['title' => '相关度阈值', 'description' => '置信度,仅供参考', 'type' => 'number', 'format' => 'double', 'example' => '0.1'],
+ 'From' => ['title' => '开始位置', 'description' => '开始时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'To' => ['title' => '开始位置', 'description' => '结束时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'Text' => ['title' => '如果是asr,那就是asr转写结果', 'description' => '对应文本,比如asr转写结果', 'type' => 'string', 'example' => 'xx'],
+ 'Type' => ['title' => '默认空', 'description' => '类型:比如asr', 'type' => 'string', 'example' => 'asr'],
],
],
],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'TimelineDateStr' => [
- 'title' => '时间脉络-时间',
- 'description' => '时间脉络-时间',
- 'type' => 'string',
- 'example' => '时间脉络-时间',
- ],
- 'Current' => [
- 'title' => '当前页',
- 'description' => '当前页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '每页条数',
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '总条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SearchType' => [
- 'title' => '搜索类型',
- 'description' => '搜索类型',
- 'type' => 'string',
- 'example' => 'realtime',
- ],
- 'SearchQuery' => [
- 'title' => '搜索条件',
- 'description' => '搜索query',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'TimelineDateStr' => ['title' => '时间脉络-时间', 'description' => '时间脉络-时间', 'type' => 'string', 'example' => '时间脉络-时间'],
+ 'Current' => ['title' => '当前页', 'description' => '当前页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SearchType' => ['title' => '搜索类型', 'description' => '搜索类型', 'type' => 'string', 'example' => 'realtime'],
+ 'SearchQuery' => ['title' => '搜索条件', 'description' => '搜索query', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -35364,13 +21883,7 @@
'description' => '溯源信息',
'type' => 'object',
'properties' => [
- 'Duplicate' => [
- 'title' => '相关度',
- 'description' => '综合溯源相关度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
+ 'Duplicate' => ['title' => '相关度', 'description' => '综合溯源相关度', 'type' => 'number', 'format' => 'double', 'example' => '0.9'],
'Coordinates' => [
'title' => '溯源信息列表',
'description' => '溯源位置列表',
@@ -35384,27 +21897,9 @@
'description' => '生成文档块的坐标',
'type' => 'object',
'properties' => [
- 'X' => [
- 'title' => '文章标号:1开始 为了和文章id对应',
- 'description' => '编号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Y' => [
- 'title' => '文本开始位置',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Z' => [
- 'title' => '文本结束位置',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'X' => ['title' => '文章标号:1开始 为了和文章id对应', 'description' => '编号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Y' => ['title' => '文本开始位置', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Z' => ['title' => '文本结束位置', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'NewsCoordinate' => [
@@ -35412,33 +21907,10 @@
'description' => '参考文档块的坐标',
'type' => 'object',
'properties' => [
- 'X' => [
- 'title' => '文章标号:1开始 为了和文章id对应',
- 'description' => '编号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Y' => [
- 'title' => '文本开始位置',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Z' => [
- 'title' => '文本结束位置',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MediaType' => [
- 'title' => '媒资类型',
- 'description' => '媒资类型',
- 'type' => 'string',
- 'example' => 'image',
- ],
+ 'X' => ['title' => '文章标号:1开始 为了和文章id对应', 'description' => '编号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Y' => ['title' => '文本开始位置', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Z' => ['title' => '文本结束位置', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'MediaType' => ['title' => '媒资类型', 'description' => '媒资类型', 'type' => 'string', 'example' => 'image'],
],
],
],
@@ -35446,26 +21918,11 @@
],
],
],
- 'GenerateFinished' => [
- 'title' => '是否生成完成',
- 'description' => '当前agent是否生成完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'GenerateLevel' => [
- 'title' => '生成等级',
- 'description' => '回答的详细程度:'."\n"
- .'- concise:简洁(默认)'."\n"
- .'- enhance:增强',
- 'type' => 'string',
- 'example' => 'concise',
- ],
- 'ReasonTextGenerate' => [
- 'title' => '深度思考内容',
- 'description' => '深度思考内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'GenerateFinished' => ['title' => '是否生成完成', 'description' => '当前agent是否生成完成', 'type' => 'boolean', 'example' => 'true'],
+ 'GenerateLevel' => ['title' => '生成等级', 'description' => '回答的详细程度:'."\n"
+ .'- concise:简洁(默认)'."\n"
+ .'- enhance:增强', 'type' => 'string', 'example' => 'concise'],
+ 'ReasonTextGenerate' => ['title' => '深度思考内容', 'description' => '深度思考内容', 'type' => 'string', 'example' => 'xx'],
],
],
'TimelineResult' => [
@@ -35473,12 +21930,7 @@
'description' => '按时间总结结果',
'type' => 'object',
'properties' => [
- 'TextGenerate' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'TextGenerate' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => 'xx'],
'ReferenceList' => [
'title' => '引用文章列表',
'description' => '参考文章列表',
@@ -35487,131 +21939,35 @@
'description' => '参考文章',
'type' => 'object',
'properties' => [
- 'TraceabilityId' => [
- 'title' => '溯源定位',
- 'description' => '溯源定位id',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'SearchSourceType' => [
- 'title' => '搜索信源类型,同searchSource.code',
- 'description' => '搜索信源类型,同searchSource.code',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '搜索信源唯一标识,同searchSource.datasetName',
- 'description' => '搜索信源唯一标识,同searchSource.datasetName',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-04-04 08:39:09',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '新华社',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Select' => [
- 'title' => '参照与否',
- 'description' => '选择情况',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Score' => [
- 'title' => '相关度',
- 'description' => '置信度,仅供参考',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '0.99',
- ],
+ 'TraceabilityId' => ['title' => '溯源定位', 'description' => '溯源定位id', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'SearchSourceType' => ['title' => '搜索信源类型,同searchSource.code', 'description' => '搜索信源类型,同searchSource.code', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '搜索信源唯一标识,同searchSource.datasetName', 'description' => '搜索信源唯一标识,同searchSource.datasetName', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-04-04 08:39:09'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '新华社'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Content' => ['title' => '内容', 'description' => '正文', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'Select' => ['title' => '参照与否', 'description' => '选择情况', 'type' => 'boolean', 'example' => 'true'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Score' => ['title' => '相关度', 'description' => '置信度,仅供参考', 'type' => 'number', 'format' => 'float', 'example' => '0.99'],
'Chunks' => [
'title' => '相关chunk',
'description' => '片段列表',
'type' => 'array',
- 'items' => [
- 'description' => '片段',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '片段', 'type' => 'string', 'example' => 'xx'],
],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -35635,58 +21991,18 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值:'."\n"
- .'video:视频。'."\n"
- .'image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值:'."\n"
+ .'video:视频。'."\n"
+ .'image:图片。', 'type' => 'string', 'example' => 'image'],
'ClipInfos' => [
'title' => '匹配信息',
'description' => '匹配信息列表',
@@ -35695,57 +22011,19 @@
'description' => '匹配信息',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'title' => '相关度阈值',
- 'description' => '置信度,仅供参考',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.99',
- ],
- 'From' => [
- 'title' => '开始位置',
- 'description' => '开始时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'To' => [
- 'title' => '开始位置',
- 'description' => '结束时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'Text' => [
- 'title' => '如果是asr,那就是asr转写结果',
- 'description' => '对应文本,比如asr转写结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Type' => [
- 'title' => '默认空',
- 'description' => '类型:比如asr',
- 'type' => 'string',
- 'example' => 'asr',
- ],
+ 'Score' => ['title' => '相关度阈值', 'description' => '置信度,仅供参考', 'type' => 'number', 'format' => 'double', 'example' => '0.99'],
+ 'From' => ['title' => '开始位置', 'description' => '开始时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'To' => ['title' => '开始位置', 'description' => '结束时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'Text' => ['title' => '如果是asr,那就是asr转写结果', 'description' => '对应文本,比如asr转写结果', 'type' => 'string', 'example' => 'xx'],
+ 'Type' => ['title' => '默认空', 'description' => '类型:比如asr', 'type' => 'string', 'example' => 'asr'],
],
],
],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件 URL。',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件 URL。', 'type' => 'string', 'example' => 'xx'],
],
],
],
- 'TimelineDateStr' => [
- 'title' => '时间脉络-时间',
- 'description' => '时间字符串',
- 'type' => 'string',
- 'example' => '2024-09-11',
- ],
+ 'TimelineDateStr' => ['title' => '时间脉络-时间', 'description' => '时间字符串', 'type' => 'string', 'example' => '2024-09-11'],
],
],
],
@@ -35754,13 +22032,7 @@
'description' => '溯源信息',
'type' => 'object',
'properties' => [
- 'Duplicate' => [
- 'title' => '相关度',
- 'description' => '相关度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
+ 'Duplicate' => ['title' => '相关度', 'description' => '相关度', 'type' => 'number', 'format' => 'double', 'example' => '0.9'],
'Coordinates' => [
'title' => '溯源信息列表',
'description' => '溯源位置',
@@ -35774,27 +22046,9 @@
'description' => '生成文档块的坐标',
'type' => 'object',
'properties' => [
- 'X' => [
- 'title' => '文章标号:1开始 为了和文章id对应',
- 'description' => '编号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Y' => [
- 'title' => '文本开始位置',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Z' => [
- 'title' => '文本结束位置',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'X' => ['title' => '文章标号:1开始 为了和文章id对应', 'description' => '编号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Y' => ['title' => '文本开始位置', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Z' => ['title' => '文本结束位置', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
],
'NewsCoordinate' => [
@@ -35802,33 +22056,10 @@
'description' => '参照文章的坐标',
'type' => 'object',
'properties' => [
- 'X' => [
- 'title' => '文章标号:1开始 为了和文章id对应',
- 'description' => '编号:1开始',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Y' => [
- 'title' => '文本开始位置',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Z' => [
- 'title' => '文本结束位置',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'MediaType' => [
- 'title' => '媒资类型',
- 'description' => '媒资类型',
- 'type' => 'string',
- 'example' => 'image',
- ],
+ 'X' => ['title' => '文章标号:1开始 为了和文章id对应', 'description' => '编号:1开始', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Y' => ['title' => '文本开始位置', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Z' => ['title' => '文本结束位置', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'MediaType' => ['title' => '媒资类型', 'description' => '媒资类型', 'type' => 'string', 'example' => 'image'],
],
],
],
@@ -35843,20 +22074,8 @@
'description' => '配图',
'type' => 'object',
'properties' => [
- 'Start' => [
- 'title' => '段落开始',
- 'description' => '开始位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'End' => [
- 'title' => '段落结束',
- 'description' => '结束位置',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Start' => ['title' => '段落开始', 'description' => '开始位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'End' => ['title' => '段落结束', 'description' => '结束位置', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'MultimodalMediaList' => [
'title' => '段落溯源信息对应的多模态',
'description' => '多模态数据列表',
@@ -35870,82 +22089,27 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xxxx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据文件类型,取值:'."\n"
- .'video:视频。'."\n"
- .'image:图片。',
- 'type' => 'string',
- 'example' => 'image',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'MediaType' => ['title' => '多模态数据类型', 'description' => '多模态数据文件类型,取值:'."\n"
+ .'video:视频。'."\n"
+ .'image:图片。', 'type' => 'string', 'example' => 'image'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
],
],
],
],
],
],
- 'GenerateFinished' => [
- 'title' => '是否生成完成',
- 'description' => '当前agent是否生成完成',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ReasonTextGenerate' => [
- 'title' => '深度思考内容',
- 'description' => '深度思考内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'GenerateFinished' => ['title' => '是否生成完成', 'description' => '当前agent是否生成完成', 'type' => 'boolean', 'example' => 'true'],
+ 'ReasonTextGenerate' => ['title' => '深度思考内容', 'description' => '深度思考内容', 'type' => 'string', 'example' => 'xx'],
],
],
'VideoSearchResult' => [
@@ -35965,79 +22129,24 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签。',
'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '多模态数据唯一标识', 'type' => 'string', 'example' => 'xx'],
'ClipInfos' => [
'title' => '匹配信息',
'description' => '匹配信息列表',
@@ -36046,54 +22155,16 @@
'description' => '匹配信息',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'title' => '相关度阈值',
- 'description' => '参考置信度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.8',
- ],
- 'From' => [
- 'title' => '开始位置',
- 'description' => '片段起始时间。',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'To' => [
- 'title' => '开始位置',
- 'description' => '结束时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'Text' => [
- 'title' => '如果是asr,那就是asr转写结果',
- 'description' => '对应文本,比如asr转写结果',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Type' => [
- 'title' => '默认空',
- 'description' => '类型:比如asr',
- 'type' => 'string',
- 'example' => 'asr',
- ],
+ 'Score' => ['title' => '相关度阈值', 'description' => '参考置信度', 'type' => 'number', 'format' => 'double', 'example' => '0.8'],
+ 'From' => ['title' => '开始位置', 'description' => '片段起始时间。', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'To' => ['title' => '开始位置', 'description' => '结束时间', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'Text' => ['title' => '如果是asr,那就是asr转写结果', 'description' => '对应文本,比如asr转写结果', 'type' => 'string', 'example' => 'xx'],
+ 'Type' => ['title' => '默认空', 'description' => '类型:比如asr', 'type' => 'string', 'example' => 'asr'],
],
],
],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'TraceabilityId' => [
- 'title' => '溯源唯一标识',
- 'description' => '溯源唯一标识',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
+ 'TraceabilityId' => ['title' => '溯源唯一标识', 'description' => '溯源唯一标识', 'type' => 'string', 'example' => '1'],
],
],
],
@@ -36116,91 +22187,26 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'SearchSourceName' => [
- 'title' => '搜索信源名称',
- 'description' => '搜索信源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'SearchSourceName' => ['title' => '搜索信源名称', 'description' => '搜索信源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段 1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段 1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '媒体数据唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'TraceabilityId' => [
- 'title' => '溯源唯一标识',
- 'description' => '溯源唯一标识',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'MediaId' => ['title' => '多模态数据唯一标识', 'description' => '媒体数据唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'FileUrl' => ['title' => '图片或视频文件地址', 'description' => '文件url', 'type' => 'string', 'example' => 'xx'],
+ 'TraceabilityId' => ['title' => '溯源唯一标识', 'description' => '溯源唯一标识', 'type' => 'string', 'example' => '1'],
],
],
],
@@ -36211,27 +22217,9 @@
'description' => '文本文档搜索结果',
'type' => 'object',
'properties' => [
- 'Current' => [
- 'title' => '当前页',
- 'description' => '当前页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'title' => '当前页大小',
- 'description' => '当前页大小',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Total' => [
- 'title' => '总条数',
- 'description' => '总条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'Current' => ['title' => '当前页', 'description' => '当前页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '当前页大小', 'description' => '当前页大小', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Total' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
'SearchResult' => [
'title' => '搜素结构',
'description' => '搜素结构',
@@ -36241,101 +22229,26 @@
'description' => '搜索结果',
'type' => 'object',
'properties' => [
- 'DocId' => [
- 'title' => '文档业务唯一标识',
- 'description' => '文档业务唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocUuid' => [
- 'title' => '系统内部文档唯一标识',
- 'description' => '系统内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceType' => [
- 'title' => '数据源类型',
- 'description' => '数据源类型',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'SearchSource' => [
- 'title' => '数据源唯一标识',
- 'description' => '数据源唯一标识',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceName' => [
- 'title' => '数据源描述',
- 'description' => '数据源描述',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-11-25 14:25:59',
- ],
- 'Content' => [
- 'title' => '正文',
- 'description' => '正文',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'TraceabilityId' => [
- 'title' => '溯源唯一标识',
- 'description' => '溯源唯一标识',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'DocId' => ['title' => '文档业务唯一标识', 'description' => '文档业务唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'DocUuid' => ['title' => '系统内部文档唯一标识', 'description' => '系统内部文档唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceType' => ['title' => '数据源类型', 'description' => '数据源类型', 'type' => 'string', 'example' => 'SystemSearch'],
+ 'SearchSource' => ['title' => '数据源唯一标识', 'description' => '数据源唯一标识', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '数据源描述', 'description' => '数据源描述', 'type' => 'string', 'example' => 'xxx'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-11-25 14:25:59'],
+ 'Content' => ['title' => '正文', 'description' => '正文', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'xx'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xx'],
+ 'TraceabilityId' => ['title' => '溯源唯一标识', 'description' => '溯源唯一标识', 'type' => 'string', 'example' => '1'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -36355,88 +22268,28 @@
'description' => '语音结果',
'type' => 'object',
'properties' => [
- 'MediaId' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'FileUrl' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
+ 'MediaId' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => 'xxx'],
+ 'FileUrl' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'http://xxx'],
'Article' => [
'title' => '归属文档',
'description' => '归属文档',
'type' => 'object',
'properties' => [
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Url' => [
- 'title' => 'url',
- 'description' => 'url',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- 'Summary' => [
- 'title' => '摘要',
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DocUuid' => [
- 'title' => 'uuid',
- 'description' => 'uuid',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocId' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'SearchSourceName' => [
- 'title' => '搜索源',
- 'description' => '搜索源',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'Url' => ['title' => 'url', 'description' => 'url', 'type' => 'string', 'example' => 'http://xxx'],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'example' => 'xxx'],
+ 'DocUuid' => ['title' => 'uuid', 'description' => 'uuid', 'type' => 'string', 'example' => 'xx'],
+ 'DocId' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceName' => ['title' => '搜索源', 'description' => '搜索源', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签列表',
'type' => 'array',
- 'items' => [
- 'description' => '标签值。',
- 'type' => 'string',
- 'example' => 'x',
- ],
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '标签值。', 'type' => 'string', 'example' => 'x'],
],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
],
],
'ClipInfos' => [
@@ -36448,48 +22301,15 @@
'description' => '匹配信息',
'type' => 'object',
'properties' => [
- 'Score' => [
- 'title' => '阈值',
- 'description' => '阈值',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.9',
- ],
- 'From' => [
- 'title' => '开始位置',
- 'description' => '开始位置',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '1',
- ],
- 'To' => [
- 'title' => '结束位置',
- 'description' => '结束位置',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '2',
- ],
- 'Text' => [
- 'title' => '文本内容',
- 'description' => '文本内容',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Type' => [
- 'title' => '文本类型',
- 'description' => '文本类型',
- 'type' => 'string',
- 'example' => 'asr',
- ],
+ 'Score' => ['title' => '阈值', 'description' => '阈值', 'type' => 'number', 'format' => 'double', 'example' => '0.9'],
+ 'From' => ['title' => '开始位置', 'description' => '开始位置', 'type' => 'number', 'format' => 'double', 'example' => '1'],
+ 'To' => ['title' => '结束位置', 'description' => '结束位置', 'type' => 'number', 'format' => 'double', 'example' => '2'],
+ 'Text' => ['title' => '文本内容', 'description' => '文本内容', 'type' => 'string', 'example' => 'xx'],
+ 'Type' => ['title' => '文本类型', 'description' => '文本类型', 'type' => 'string', 'example' => 'asr'],
],
],
],
- 'TraceabilityId' => [
- 'title' => '溯源唯一标识',
- 'description' => '溯源唯一标识',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'TraceabilityId' => ['title' => '溯源唯一标识', 'description' => '溯源唯一标识', 'type' => 'string', 'example' => '1'],
],
],
],
@@ -36501,107 +22321,40 @@
'title' => '思考-query理解关键词列表',
'description' => '思考-query理解关键词列表',
'type' => 'array',
- 'items' => [
- 'description' => '思考-query理解关键词',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '思考-query理解关键词', 'type' => 'string', 'example' => 'xx'],
],
'SearchQueryList' => [
'title' => '搜素-文本搜索query',
'description' => '文本搜索query列表',
'type' => 'array',
- 'items' => [
- 'description' => '文本搜索query',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '文本搜索query', 'type' => 'string', 'example' => 'xx'],
],
'RecommendSearchQueryList' => [
'title' => '生成-推荐搜索',
'description' => '生成-推荐列表',
'type' => 'array',
- 'items' => [
- 'description' => '生成-推荐',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'SupplementDataType' => [
- 'title' => '补充数据类型',
- 'description' => '思考-需要补充的数据类型:searchQuery',
- 'type' => 'string',
- 'example' => 'searchQuery',
- ],
- 'SupplementEnable' => [
- 'title' => '是否补充',
- 'description' => '思考-是否需要补充',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'ModelId' => [
- 'title' => '模型id',
- 'description' => '模型id',
- 'type' => 'string',
- 'example' => 'xx',
+ 'items' => ['description' => '生成-推荐', 'type' => 'string', 'example' => 'xx'],
],
+ 'SupplementDataType' => ['title' => '补充数据类型', 'description' => '思考-需要补充的数据类型:searchQuery', 'type' => 'string', 'example' => 'searchQuery'],
+ 'SupplementEnable' => ['title' => '是否补充', 'description' => '思考-是否需要补充', 'type' => 'boolean', 'example' => 'true'],
+ 'ModelId' => ['title' => '模型id', 'description' => '模型id', 'type' => 'string', 'example' => 'xx'],
'TokenCalculate' => [
'description' => '运行统计信息',
'type' => 'object',
'properties' => [
- 'FirstTokenTime' => [
- 'title' => '首TOKEN时间',
- 'description' => '首TOKEN时间',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'SearchTime' => [
- 'title' => '搜索耗时',
- 'description' => '搜索耗时',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'OutputAvgTime' => [
- 'title' => '每秒平均输出的token数量',
- 'description' => '每秒平均输出的token数量',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'Time' => [
- 'title' => '总耗时',
- 'description' => '总耗时',
- 'type' => 'number',
- 'format' => 'float',
- 'example' => '1',
- ],
- 'TotalTokens' => [
- 'title' => '总token数',
- 'description' => '总token数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'FirstTokenTime' => ['title' => '首TOKEN时间', 'description' => '首TOKEN时间', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'SearchTime' => ['title' => '搜索耗时', 'description' => '搜索耗时', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'OutputAvgTime' => ['title' => '每秒平均输出的token数量', 'description' => '每秒平均输出的token数量', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'Time' => ['title' => '总耗时', 'description' => '总耗时', 'type' => 'number', 'format' => 'float', 'example' => '1'],
+ 'TotalTokens' => ['title' => '总token数', 'description' => '总token数', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'AskUser' => [
- 'title' => '反问',
- 'description' => '反问',
- 'type' => 'string',
- 'example' => '您想了解关于xx的哪些信息?',
- ],
+ 'AskUser' => ['title' => '反问', 'description' => '反问', 'type' => 'string', 'example' => '您想了解关于xx的哪些信息?'],
'AskUserKeywords' => [
'title' => '反问推荐关键词列表',
'description' => '反问推荐关键词列表',
'type' => 'array',
- 'items' => [
- 'title' => '反问推荐关键词',
- 'description' => '反问推荐关键词',
- 'type' => 'string',
- 'example' => '时间',
- ],
+ 'items' => ['title' => '反问推荐关键词', 'description' => '反问推荐关键词', 'type' => 'string', 'example' => '时间'],
],
],
],
@@ -36616,38 +22369,15 @@
'description' => '研究模式消息',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '节点id',
- 'description' => '节点id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Content' => [
- 'title' => '生成文本',
- 'description' => '生成文本',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'GenerateFinished' => [
- 'title' => '当前节点是否完成',
- 'description' => '当前节点是否完成',
- 'type' => 'boolean',
- ],
- 'Clarifications' => [
- 'title' => '是否需要澄清',
- 'description' => '是否需要澄清',
- 'type' => 'boolean',
- ],
+ 'Id' => ['title' => '节点id', 'description' => '节点id', 'type' => 'string', 'example' => 'xx'],
+ 'Content' => ['title' => '生成文本', 'description' => '生成文本', 'type' => 'string', 'example' => 'xx'],
+ 'GenerateFinished' => ['title' => '当前节点是否完成', 'description' => '当前节点是否完成', 'type' => 'boolean'],
+ 'Clarifications' => ['title' => '是否需要澄清', 'description' => '是否需要澄清', 'type' => 'boolean'],
'SearchQueries' => [
'title' => '搜索query列表',
'description' => '搜索query列表',
'type' => 'array',
- 'items' => [
- 'title' => '搜索query',
- 'description' => '搜索query',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'items' => ['title' => '搜索query', 'description' => '搜索query', 'type' => 'string', 'example' => 'xx'],
],
'SearchResult' => [
'title' => '搜索结果',
@@ -36658,12 +22388,7 @@
'description' => '搜索结果',
'type' => 'object',
'properties' => [
- 'MultimodalSearchQuery' => [
- 'title' => '多模态搜索query',
- 'description' => '多模态搜索query',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MultimodalSearchQuery' => ['title' => '多模态搜索query', 'description' => '多模态搜索query', 'type' => 'string', 'example' => 'xx'],
'Texts' => [
'title' => '文本搜索列表',
'description' => '文本搜索列表',
@@ -36673,12 +22398,7 @@
'description' => '文本搜索',
'type' => 'object',
'properties' => [
- 'DocUuid' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'DocUuid' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -36691,12 +22411,7 @@
'description' => '图片搜索',
'type' => 'object',
'properties' => [
- 'MediaId' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -36709,12 +22424,7 @@
'description' => '音频结果',
'type' => 'object',
'properties' => [
- 'MediaId' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'MediaId' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -36727,42 +22437,27 @@
'description' => '视频结果',
'type' => 'object',
'properties' => [
- 'MediaId' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => '1',
- ],
+ 'MediaId' => ['title' => 'id', 'description' => 'id', 'type' => 'string', 'example' => '1'],
],
],
],
],
],
],
- 'NodeCode' => [
- 'title' => '节点code:'."\n"
- .'- generateStartStatement'."\n"
- .'- generateSearchQueries'."\n"
- .'- multiSearch'."\n"
- .'- readSearchResult'."\n"
- .'- reflection'."\n"
- .'- generate',
- 'description' => '节点code:'."\n"
- .'- generateStartStatement'."\n"
- .'- generateSearchQueries'."\n"
- .'- multiSearch'."\n"
- .'- readSearchResult'."\n"
- .'- reflection'."\n"
- .'- generate',
- 'type' => 'string',
- 'example' => 'generateStartStatement',
- ],
- 'SearchQuery' => [
- 'title' => '当前节点搜索query',
- 'description' => '当前节点搜索query',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'NodeCode' => ['title' => '节点code:'."\n"
+ .'- generateStartStatement'."\n"
+ .'- generateSearchQueries'."\n"
+ .'- multiSearch'."\n"
+ .'- readSearchResult'."\n"
+ .'- reflection'."\n"
+ .'- generate', 'description' => '节点code:'."\n"
+ .'- generateStartStatement'."\n"
+ .'- generateSearchQueries'."\n"
+ .'- multiSearch'."\n"
+ .'- readSearchResult'."\n"
+ .'- reflection'."\n"
+ .'- generate', 'type' => 'string', 'example' => 'generateStartStatement'],
+ 'SearchQuery' => ['title' => '当前节点搜索query', 'description' => '当前节点搜索query', 'type' => 'string', 'example' => 'xx'],
],
],
],
@@ -36772,27 +22467,9 @@
'description' => 'token用量',
'type' => 'object',
'properties' => [
- 'OutputTokens' => [
- 'title' => '输出token',
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2',
- ],
- 'InputTokens' => [
- 'title' => '输入tokne',
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalTokens' => [
- 'title' => '总token',
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '3',
- ],
+ 'OutputTokens' => ['title' => '输出token', 'description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
+ 'InputTokens' => ['title' => '输入tokne', 'description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TotalTokens' => ['title' => '总token', 'description' => '总oken数量', 'type' => 'integer', 'format' => 'int64', 'example' => '3'],
],
],
],
@@ -36802,86 +22479,32 @@
'description' => '响应头',
'type' => 'object',
'properties' => [
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '对话ID',
- 'type' => 'string',
- 'example' => 'x',
- ],
- 'TraceId' => [
- 'title' => '全链路ID',
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'x',
- ],
- 'OriginSessionId' => [
- 'title' => '源会话ID',
- 'description' => '源会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'AccessForbid',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '异常错误信息',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'EventInfo' => [
- 'title' => '事件信息描述',
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'ResponseTime' => [
- 'title' => '耗时',
- 'description' => '响应时间,单位为毫秒(ms)。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
+ 'SessionId' => ['title' => '会话ID', 'description' => '对话ID', 'type' => 'string', 'example' => 'x'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => 'xx'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'x'],
+ 'OriginSessionId' => ['title' => '源会话ID', 'description' => '源会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。', 'type' => 'string', 'example' => 'task-failed'],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'AccessForbid'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '异常错误信息', 'type' => 'string', 'example' => 'xx'],
+ 'EventInfo' => ['title' => '事件信息描述', 'description' => '事件描述', 'type' => 'string', 'example' => 'xx'],
+ 'ResponseTime' => ['title' => '耗时', 'description' => '响应时间,单位为毫秒(ms)。', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
],
],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => 'xx'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"AgentContext\\": {\\n \\"BizContext\\": {\\n \\"CurrentStep\\": \\"start\\",\\n \\"NextStep\\": \\"search\\",\\n \\"GeneratedContent\\": {\\n \\"ClusterTopicResult\\": {\\n \\"ClusterTopics\\": [\\n {\\n \\"Topic\\": \\"xx\\",\\n \\"ImageSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n },\\n \\"TextSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n },\\n \\"VideoSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"x\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.9,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n },\\n \\"AudioSearchResult\\": {\\n \\"SearchResult\\": {\\n \\"FileUrl\\": \\"http://xx\\",\\n \\"MediaId\\": \\"xxx\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 1,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"Article\\": {\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\"\\n }\\n },\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n }\\n }\\n ],\\n \\"TextGenerate\\": \\"xx\\",\\n \\"GenerateFinished\\": true\\n },\\n \\"ExcerptResult\\": {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"SearchResult\\": [\\n {\\n \\"TraceabilityId\\": 1,\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Excerpt\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"Chunks\\": [\\n \\"xx\\"\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"TextGenerateMultimodalMediaList\\": [\\n {\\n \\"Start\\": 1,\\n \\"End\\": 1,\\n \\"DocUuid\\": \\"xx\\",\\n \\"MultimodalMediaList\\": [\\n {\\n \\"Article\\": {\\n \\"DocId\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ]\\n }\\n ],\\n \\"GenerateFinished\\": true,\\n \\"GenerateLevel\\": \\"concise\\",\\n \\"ReasonTextGenerate\\": \\"xx\\"\\n },\\n \\"NewsElementResult\\": {\\n \\"TextGenerate\\": \\"x\\",\\n \\"NewsElementArticleList\\": [\\n {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"Article\\": {\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"NewsElementList\\": [\\n {\\n \\"Time\\": \\"时间\\",\\n \\"Location\\": \\"xx\\",\\n \\"People\\": \\"xx\\",\\n \\"Event\\": {\\n \\"CauseList\\": [\\n \\"xx\\"\\n ],\\n \\"ProcessList\\": [\\n \\"xx\\"\\n ],\\n \\"ResultList\\": [\\n \\"xx\\"\\n ]\\n }\\n }\\n ]\\n }\\n ],\\n \\"GenerateFinished\\": true\\n },\\n \\"TextGenerateResult\\": {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"TextGenerateMultimodalMediaList\\": [\\n {\\n \\"Start\\": 1,\\n \\"End\\": 1,\\n \\"MultimodalMediaList\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"ReferenceList\\": [\\n {\\n \\"TraceabilityId\\": 1,\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Source\\": \\"新华社\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"Chunks\\": [\\n \\"xx\\"\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"MultimodalSearchResultList\\": [\\n {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.1,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"TimelineDateStr\\": \\"时间脉络-时间\\",\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1,\\n \\"SearchType\\": \\"realtime\\",\\n \\"SearchQuery\\": \\"xx\\"\\n }\\n ],\\n \\"GenerateTraceability\\": {\\n \\"Duplicate\\": 0.9,\\n \\"Coordinates\\": [\\n {\\n \\"GenerateCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1\\n },\\n \\"NewsCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1,\\n \\"MediaType\\": \\"image\\"\\n }\\n }\\n ]\\n },\\n \\"GenerateFinished\\": true,\\n \\"GenerateLevel\\": \\"concise\\",\\n \\"ReasonTextGenerate\\": \\"xx\\"\\n },\\n \\"TimelineResult\\": {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"ReferenceList\\": [\\n {\\n \\"TraceabilityId\\": 1,\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Source\\": \\"新华社\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"Chunks\\": [\\n \\"xx\\"\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"MultimodalSearchResultList\\": [\\n {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.99,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"TimelineDateStr\\": \\"2024-09-11\\"\\n }\\n ],\\n \\"GenerateTraceability\\": {\\n \\"Duplicate\\": 0.9,\\n \\"Coordinates\\": [\\n {\\n \\"GenerateCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1\\n },\\n \\"NewsCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1,\\n \\"MediaType\\": \\"image\\"\\n }\\n }\\n ]\\n },\\n \\"TextGenerateMultimodalMediaList\\": [\\n {\\n \\"Start\\": 1,\\n \\"End\\": 1,\\n \\"MultimodalMediaList\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xxxx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"GenerateFinished\\": true,\\n \\"ReasonTextGenerate\\": \\"xx\\"\\n },\\n \\"VideoSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.8,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\",\\n \\"TraceabilityId\\": \\"1\\"\\n }\\n ]\\n },\\n \\"ImageSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"FileUrl\\": \\"xx\\",\\n \\"TraceabilityId\\": \\"1\\"\\n }\\n ]\\n },\\n \\"TextSearchResult\\": {\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1,\\n \\"SearchResult\\": [\\n {\\n \\"DocId\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"xxx\\",\\n \\"PubTime\\": \\"2024-11-25 14:25:59\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"TraceabilityId\\": \\"1\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"AudioSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"MediaId\\": \\"xxx\\",\\n \\"FileUrl\\": \\"http://xxx\\",\\n \\"Article\\": {\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"http://xxx\\",\\n \\"Summary\\": \\"xxx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"x\\"\\n ],\\n \\"CategoryUuid\\": \\"xx\\"\\n },\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.9,\\n \\"From\\": 1,\\n \\"To\\": 2,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"TraceabilityId\\": \\"1\\"\\n }\\n ]\\n }\\n },\\n \\"SearchKeywords\\": [\\n \\"xx\\"\\n ],\\n \\"SearchQueryList\\": [\\n \\"xx\\"\\n ],\\n \\"RecommendSearchQueryList\\": [\\n \\"xx\\"\\n ],\\n \\"SupplementDataType\\": \\"searchQuery\\",\\n \\"SupplementEnable\\": true,\\n \\"ModelId\\": \\"xx\\",\\n \\"TokenCalculate\\": {\\n \\"FirstTokenTime\\": 1,\\n \\"SearchTime\\": 1,\\n \\"OutputAvgTime\\": 1,\\n \\"Time\\": 1,\\n \\"TotalTokens\\": 1\\n },\\n \\"AskUser\\": \\"您想了解关于xx的哪些信息?\\",\\n \\"AskUserKeywords\\": [\\n \\"时间\\"\\n ]\\n }\\n },\\n \\"Messages\\": [\\n {\\n \\"Id\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"GenerateFinished\\": true,\\n \\"Clarifications\\": true,\\n \\"SearchQueries\\": [\\n \\"xx\\"\\n ],\\n \\"SearchResult\\": [\\n {\\n \\"MultimodalSearchQuery\\": \\"xx\\",\\n \\"Texts\\": [\\n {\\n \\"DocUuid\\": \\"xx\\"\\n }\\n ],\\n \\"Images\\": [\\n {\\n \\"MediaId\\": \\"xx\\"\\n }\\n ],\\n \\"Audios\\": [\\n {\\n \\"MediaId\\": \\"xx\\"\\n }\\n ],\\n \\"Videos\\": [\\n {\\n \\"MediaId\\": \\"1\\"\\n }\\n ]\\n }\\n ],\\n \\"NodeCode\\": \\"generateStartStatement\\",\\n \\"SearchQuery\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"OutputTokens\\": 2,\\n \\"InputTokens\\": 1,\\n \\"TotalTokens\\": 3\\n }\\n },\\n \\"Header\\": {\\n \\"SessionId\\": \\"x\\",\\n \\"TraceId\\": \\"xx\\",\\n \\"TaskId\\": \\"x\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"EventInfo\\": \\"xx\\",\\n \\"ResponseTime\\": 1\\n },\\n \\"RequestId\\": \\"xx\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '妙搜-智能搜索',
+ 'summary' => 'AI妙搜-智能搜索生成:对应妙搜首页的搜索生成能力。此接口支持通用搜索和媒资搜索。支持用户问题澄清、多模态知识搜索、多agent生成等能力。'."\n"
+ .'- 通用搜索:可以对数据集中知识进行语义检索,并对搜索结果进行多agent后处理,包括总结生成、摘编、时间线总结等。'."\n"
+ .'- 媒资搜索:应搜尽搜,全文检索,召回更多相关知识,并可进行多agent后处理,包括聚类、新闻抽取等。',
'description' => '### 接入说明:'."\n"
.'- 当前接口为http-sse协议。'."\n"
.'- 由于OpenAPI门户目前对SSE推理协议不兼容(无法直接调试),接口SDK方式调用示例(支持**java、python**版本的**sdk**)请参考[妙搜最佳实践](https://help.aliyun.com/zh/model-studio/user-guide/best-practices-for-miaosou-api/?spm=a2c4g.11186623.help-menu-2400256.d_1_3_3_2_1_2.42a64a34eIyBhn)文档。'."\n"
@@ -36891,964 +22514,61 @@
.'支持三种类型数据集:详见[妙搜最佳实践](https://help.aliyun.com/zh/model-studio/user-guide/best-practices-for-miaosou-api/?spm=a2c4g.11186623.help-menu-2400256.d_1_3_3_2_1_2.42a64a34eIyBhn)'."\n"
.'- 内置”互联网检索“数据集:支持互联网开放域文本、图片、视频(暂未开放)的搜索;'."\n"
.'- 语义(RAG)数据集:可以管理企业私域知识库,支持文本、图片、视频、语音(暂未开放);'."\n"
- .'- 三方api数据集:可以直接集成企业自己的搜索api。',
- ],
- 'ListSearchTasks' => [
- 'summary' => '查询妙搜搜索生成历史任务列表。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
- ],
- [
- 'name' => 'DialogueTypes',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '任务类型',
- 'description' => '任务类型',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '24',
- ],
- 'required' => false,
- 'example' => '24',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'TaskName' => [
- 'title' => '任务名称',
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-25 11:40:50',
- ],
- 'UpdateTime' => [
- 'title' => '修改时间',
- 'description' => '修改时间',
- 'type' => 'string',
- 'example' => '2024-11-25 11:40:50',
- ],
- 'DialogueType' => [
- 'title' => '任务类型',
- 'description' => '任务类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'Username' => [
- 'title' => '创建人名称',
- 'description' => '创建人名称',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录条数',
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"xxxx\\",\\n \\"TaskName\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"UpdateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"DialogueType\\": 24,\\n \\"Username\\": \\"xxxx\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '查询妙搜搜索生成历史任务列表',
- ],
- 'ListSearchTaskDialogues' => [
- 'summary' => '查询妙搜搜索生成任务详情列表。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '返回结果数量',
- 'description' => '返回结果数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '1',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
- 'type' => 'object',
- 'properties' => [
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'SessionId' => [
- 'title' => '单轮对话唯一标识',
- 'description' => '单轮对话唯一标识',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'OriginSessionId' => [
- 'title' => '原始的SessionId',
- 'description' => '原始的SessionId',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'TaskId' => [
- 'title' => '任务唯一标识',
- 'description' => '任务唯一标识',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'Rating' => [
- 'title' => '点赞点踩',
- 'description' => '点赞点踩',
- 'type' => 'string',
- 'example' => 'thumbsUp',
- ],
- 'Tags' => [
- 'title' => '标签',
- 'description' => '标签',
- 'type' => 'array',
- 'items' => [
- 'description' => '标签信息',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'Text' => [
- 'title' => '客户反馈意见',
- 'description' => '客户反馈意见',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'GoodText' => [
- 'title' => '客户认为好的生成内容',
- 'description' => '客户认为好的生成内容',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Prompt' => [
- 'title' => '输入',
- 'description' => '输入',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CreateTime' => [
- 'title' => '创建日期',
- 'description' => '创建日期',
- 'type' => 'string',
- 'example' => '2024-11-25 13:33:01',
- ],
- 'DialogueType' => [
- 'title' => '生成类型',
- 'description' => '生成类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'ResponseBodyStr' => [
- 'title' => '响应结果字符串',
- 'description' => '响应结果字符串',
- 'type' => 'string',
- 'example' => '{}',
- ],
- 'ChatConfig' => [
- 'title' => '配置',
- 'description' => '配置',
- 'type' => 'object',
- 'properties' => [
- 'GenerateTechnology' => [
- 'title' => '生成类型',
- 'description' => '生成类型',
- 'type' => 'string',
- 'example' => 'copilotReference',
- ],
- 'SearchParam' => [
- 'type' => 'object',
- 'properties' => [
- 'SearchSources' => [
- 'title' => '搜索源',
- 'description' => '搜索源',
- 'type' => 'array',
- 'items' => [
- 'title' => '搜索源',
- 'description' => '搜索源',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '类型',
- 'description' => '类型',
- 'type' => 'string',
- 'example' => 'x\'x',
- ],
- 'Name' => [
- 'title' => '描述',
- 'description' => '描述',
- 'type' => 'string',
- 'example' => 'x',
- ],
- 'DatasetName' => [
- 'title' => '唯一标识',
- 'description' => '唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- 'EndTime' => [
- 'type' => 'string',
- ],
- 'StartTime' => [
- 'type' => 'string',
- ],
- 'MultimodalSearchTypes' => [
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'DialogueType' => [
- 'title' => '请求类型',
- 'description' => '请求类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '24',
- ],
- 'GenerateLevel' => [
- 'title' => '生成级别',
- 'description' => '生成级别',
- 'type' => 'string',
- 'example' => 'concise',
- ],
- 'EndToEnd' => [
- 'title' => '是否端到端',
- 'description' => '是否端到端',
- 'type' => 'boolean',
- ],
- 'SearchModels' => [
- 'title' => '搜索类型',
- 'description' => '搜索类型',
- 'type' => 'array',
- 'items' => [
- 'title' => '搜索类型',
- 'description' => '搜索类型',
- 'type' => 'string',
- 'example' => 'TextGenerate',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录条数',
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": [\\n {\\n \\"SessionId\\": \\"xxxx\\",\\n \\"OriginSessionId\\": \\"xxxx\\",\\n \\"TaskId\\": \\"xxxx\\",\\n \\"Rating\\": \\"thumbsUp\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Text\\": \\"xxx\\",\\n \\"GoodText\\": \\"xxx\\",\\n \\"Prompt\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-25 13:33:01\\",\\n \\"DialogueType\\": 24,\\n \\"ResponseBodyStr\\": \\"{}\\",\\n \\"ChatConfig\\": {\\n \\"GenerateTechnology\\": \\"copilotReference\\",\\n \\"SearchParam\\": {\\n \\"SearchSources\\": [\\n {\\n \\"Code\\": \\"x\'x\\",\\n \\"Name\\": \\"x\\",\\n \\"DatasetName\\": \\"xx\\"\\n }\\n ],\\n \\"EndTime\\": \\"\\",\\n \\"StartTime\\": \\"\\",\\n \\"MultimodalSearchTypes\\": [\\n \\"\\"\\n ]\\n },\\n \\"DialogueType\\": 24,\\n \\"GenerateLevel\\": \\"concise\\",\\n \\"EndToEnd\\": true,\\n \\"SearchModels\\": [\\n \\"TextGenerate\\"\\n ]\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
- 'title' => '查询妙搜搜索生成任务详情列表',
- ],
- 'ListSearchTaskDialogueDatas' => [
- 'summary' => '查询搜索生成任务对话详情中数据列表。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ .'- 三方api数据集:可以直接集成企业自己的搜索api。'."\n"
+ ."\n"
+ .'## 权限说明'."\n"
+ ."\n"
+ .'### 前置条件'."\n"
+ .'- 登录阿里云百炼控制台,确认阿里云百炼是开通可用状态。'."\n"
+ .'- 主账号调用:默认有所有API调用权限。'."\n"
+ .'- 子账号调用:子账号默认无权限(AccessForbid)调用当前API,需要同时在**RAM控制台**和**阿里云百炼控制台**中做授权。'."\n"
+ ."\n"
+ .'### RAM控制台授权说明'."\n"
+ ."\n"
+ .'去[RAM控制台](https://ram.console.aliyun.com/users)授权,具体RAM授权操作,参考[RAM文档](https://help.aliyun.com/zh/ram/user-guide/create-a-custom-policy),步骤如下:'."\n"
+ ."\n"
+ .'#### 授予内置权限策略 '."\n"
+ ."\n"
+ .'授予子账号”[AliyunAiMiaoBiFullAccess](https://ram.console.aliyun.com/policies/detail?policyType=System&policyName=AliyunAiMiaoBiFullAccess)“ 权限。'."\n"
+ ."\n"
+ .'### 阿里云百炼控制台授权说明'."\n"
+ ."\n"
+ .'使用主账号或有阿里云百炼管理员权限的子账号,登录阿里云百炼控制台,在[权限管理](https://bailian.console.aliyun.com/?tab=app#/authority)页面添加子账号“新增用户”。',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-12T02:50:44.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-09-29T12:05:41.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-06-23T13:54:47.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-06-05T11:27:43.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-05-07T11:57:23.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-04-29T13:10:20.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2025-03-31T11:56:06.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => '请求参数发生变更'],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
- ],
- [
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '查询条件',
- 'description' => '查询条件',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'OriginalSessionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '历史对话唯一标识:全量原始素材来源',
- 'description' => '历史对话唯一标识:全量原始素材来源',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- ],
+ 'ramActions' => [
[
- 'name' => 'SessionId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '历史对话唯一标识:参考素材来源',
- 'description' => '历史对话唯一标识:参考素材来源',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xx',
- ],
- ],
- [
- 'name' => 'MultimodalSearchType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '搜索数据类型',
- 'description' => '搜索数据类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text',
- ],
- ],
- [
- 'name' => 'SearchModel',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '搜索agent类型',
- 'description' => '搜索agent类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ClusterGenerate',
- ],
- ],
- [
- 'name' => 'SearchModelDataValue',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '搜索agent分类下的数据',
- 'description' => '搜索agent分类下的数据',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxx',
- ],
- ],
- [
- 'name' => 'IncludeContent',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否包含正文',
- 'description' => '是否包含正文',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- 'default' => 'true',
- ],
- ],
- [
- 'name' => 'PageNumber',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '每页条数:默认10',
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'minimum' => '0',
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
- 'type' => 'object',
- 'properties' => [
- 'RealtimeSearch' => [
- 'title' => '是否实时搜索',
- 'description' => '是否实时搜索',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'SearchType' => [
- 'title' => '搜索类型',
- 'description' => '搜索类型',
- 'type' => 'string',
- 'example' => 'realtime',
- ],
- 'Articles' => [
- 'title' => '文章列表',
- 'description' => '文章列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章',
- 'type' => 'object',
- 'properties' => [
- 'PubTime' => [
- 'title' => '发布时间',
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-11-25 14:25:59',
- ],
- 'Source' => [
- 'title' => '来源',
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '新华社',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '文章标题',
- ],
- 'Content' => [
- 'title' => '内容',
- 'description' => '内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'Author' => [
- 'title' => '作者',
- 'description' => '作者',
- 'type' => 'string',
- 'example' => '作者',
- ],
- 'Url' => [
- 'title' => '文章URL',
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
- 'Summary' => [
- 'title' => '文章摘要',
- 'description' => '文章摘要',
- 'type' => 'string',
- 'example' => '文章摘要',
- ],
- 'DocUuid' => [
- 'title' => '内部文档唯一标识',
- 'description' => '内部文档唯一标识',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DocId' => [
- 'title' => '文档-自定义的唯一ID',
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => '文档-自定义的唯一ID',
- ],
- 'MultimodalMedias' => [
- 'description' => '多模态信息',
- 'type' => 'array',
- 'items' => [
- 'description' => '多模态信息',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => '多模态数据唯一标识',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据类型',
- 'type' => 'string',
- 'example' => '多模态数据类型',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '图片或视频文件地址',
- 'type' => 'string',
- 'example' => '图片或视频文件地址',
- ],
- ],
- ],
- ],
- 'DocType' => [
- 'title' => '文档类型',
- 'description' => '文档类型',
- 'type' => 'string',
- 'example' => 'text',
- ],
- 'CategoryUuid' => [
- 'title' => '类目唯一标识',
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'title' => '扩展字段1',
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'title' => '扩展字段2',
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'title' => '扩展字段3',
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- ],
- ],
- 'Images' => [
- 'title' => '图片列表',
- 'description' => '图片列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片对象',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => '多模态数据唯一标识',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据类型',
- 'type' => 'string',
- 'example' => '多模态数据类型',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '图片或视频文件地址',
- 'type' => 'string',
- 'example' => '图片或视频文件地址',
- ],
- ],
- ],
- ],
- 'Videos' => [
- 'title' => '视频列表',
- 'description' => '视频列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '视频信息列表',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => '多模态数据唯一标识',
- ],
- 'MediaType' => [
- 'title' => '多模态数据类型',
- 'description' => '多模态数据类型',
- 'type' => 'string',
- 'example' => '多模态数据类型',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '图片或视频文件地址',
- 'type' => 'string',
- 'example' => '图片或视频文件地址',
- ],
- ],
- ],
- ],
- 'PageNumber' => [
- 'title' => '当前页码',
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '每页记录条数',
- 'description' => '每页记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalCount' => [
- 'title' => '总记录条数',
- 'description' => '总记录条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Audios' => [
- 'title' => '语音列表',
- 'description' => '语音列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '语音信息',
- 'description' => '语音信息',
- 'type' => 'object',
- 'properties' => [
- 'MediaId' => [
- 'title' => '多模态数据唯一标识',
- 'description' => '多模态数据唯一标识',
- 'type' => 'string',
- 'example' => 'xxxx',
- ],
- 'FileUrl' => [
- 'title' => '图片或视频文件地址',
- 'description' => '图片或视频文件地址',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- ],
- ],
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunSearchGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RealtimeSearch\\": true,\\n \\"SearchType\\": \\"realtime\\",\\n \\"Articles\\": [\\n {\\n \\"PubTime\\": \\"2024-11-25 14:25:59\\",\\n \\"Source\\": \\"新华社\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"Author\\": \\"作者\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"DocUuid\\": \\"xxx\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"DocType\\": \\"text\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"Images\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"Videos\\": [\\n {\\n \\"MediaId\\": \\"多模态数据唯一标识\\",\\n \\"MediaType\\": \\"多模态数据类型\\",\\n \\"FileUrl\\": \\"图片或视频文件地址\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Audios\\": [\\n {\\n \\"MediaId\\": \\"xxxx\\",\\n \\"FileUrl\\": \\"http://xxx\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询搜索生成任务对话详情中数据列表',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"AgentContext\\": {\\n \\"BizContext\\": {\\n \\"CurrentStep\\": \\"start\\",\\n \\"NextStep\\": \\"search\\",\\n \\"GeneratedContent\\": {\\n \\"ClusterTopicResult\\": {\\n \\"ClusterTopics\\": [\\n {\\n \\"Topic\\": \\"xx\\",\\n \\"ImageSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n },\\n \\"TextSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n },\\n \\"VideoSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"x\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.9,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n },\\n \\"AudioSearchResult\\": {\\n \\"SearchResult\\": {\\n \\"FileUrl\\": \\"http://xx\\",\\n \\"MediaId\\": \\"xxx\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 1,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"Article\\": {\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"http://xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\"\\n }\\n },\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1\\n }\\n }\\n ],\\n \\"TextGenerate\\": \\"xx\\",\\n \\"GenerateFinished\\": true\\n },\\n \\"ExcerptResult\\": {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"SearchResult\\": [\\n {\\n \\"TraceabilityId\\": 1,\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Excerpt\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"Chunks\\": [\\n \\"xx\\"\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"TextGenerateMultimodalMediaList\\": [\\n {\\n \\"Start\\": 1,\\n \\"End\\": 1,\\n \\"DocUuid\\": \\"xx\\",\\n \\"MultimodalMediaList\\": [\\n {\\n \\"Article\\": {\\n \\"DocId\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"MultimodalMedias\\": [\\n {\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ]\\n }\\n ],\\n \\"GenerateFinished\\": true,\\n \\"GenerateLevel\\": \\"concise\\",\\n \\"ReasonTextGenerate\\": \\"xx\\"\\n },\\n \\"NewsElementResult\\": {\\n \\"TextGenerate\\": \\"x\\",\\n \\"NewsElementArticleList\\": [\\n {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"Article\\": {\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"NewsElementList\\": [\\n {\\n \\"Time\\": \\"时间\\",\\n \\"Location\\": \\"xx\\",\\n \\"People\\": \\"xx\\",\\n \\"Event\\": {\\n \\"CauseList\\": [\\n \\"xx\\"\\n ],\\n \\"ProcessList\\": [\\n \\"xx\\"\\n ],\\n \\"ResultList\\": [\\n \\"xx\\"\\n ]\\n }\\n }\\n ]\\n }\\n ],\\n \\"GenerateFinished\\": true\\n },\\n \\"TextGenerateResult\\": {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"TextGenerateMultimodalMediaList\\": [\\n {\\n \\"Start\\": 1,\\n \\"End\\": 1,\\n \\"MultimodalMediaList\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"ReferenceList\\": [\\n {\\n \\"TraceabilityId\\": 1,\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Source\\": \\"新华社\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"Chunks\\": [\\n \\"xx\\"\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"MultimodalSearchResultList\\": [\\n {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.1,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"TimelineDateStr\\": \\"时间脉络-时间\\",\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1,\\n \\"SearchType\\": \\"realtime\\",\\n \\"SearchQuery\\": \\"xx\\"\\n }\\n ],\\n \\"GenerateTraceability\\": {\\n \\"Duplicate\\": 0.9,\\n \\"Coordinates\\": [\\n {\\n \\"GenerateCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1\\n },\\n \\"NewsCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1,\\n \\"MediaType\\": \\"image\\"\\n }\\n }\\n ]\\n },\\n \\"GenerateFinished\\": true,\\n \\"GenerateLevel\\": \\"concise\\",\\n \\"ReasonTextGenerate\\": \\"xx\\"\\n },\\n \\"TimelineResult\\": {\\n \\"TextGenerate\\": \\"xx\\",\\n \\"ReferenceList\\": [\\n {\\n \\"TraceabilityId\\": 1,\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2023-04-04 08:39:09\\",\\n \\"Source\\": \\"新华社\\",\\n \\"Title\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"Select\\": true,\\n \\"DocUuid\\": \\"xx\\",\\n \\"Score\\": 0.99,\\n \\"Chunks\\": [\\n \\"xx\\"\\n ],\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ],\\n \\"MultimodalSearchResultList\\": [\\n {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.99,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ],\\n \\"TimelineDateStr\\": \\"2024-09-11\\"\\n }\\n ],\\n \\"GenerateTraceability\\": {\\n \\"Duplicate\\": 0.9,\\n \\"Coordinates\\": [\\n {\\n \\"GenerateCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1\\n },\\n \\"NewsCoordinate\\": {\\n \\"X\\": 1,\\n \\"Y\\": 1,\\n \\"Z\\": 1,\\n \\"MediaType\\": \\"image\\"\\n }\\n }\\n ]\\n },\\n \\"TextGenerateMultimodalMediaList\\": [\\n {\\n \\"Start\\": 1,\\n \\"End\\": 1,\\n \\"MultimodalMediaList\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xxxx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"MediaType\\": \\"image\\",\\n \\"FileUrl\\": \\"xx\\"\\n }\\n ]\\n }\\n ],\\n \\"GenerateFinished\\": true,\\n \\"ReasonTextGenerate\\": \\"xx\\"\\n },\\n \\"VideoSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.8,\\n \\"From\\": 1,\\n \\"To\\": 1,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"FileUrl\\": \\"xx\\",\\n \\"TraceabilityId\\": \\"1\\"\\n }\\n ]\\n },\\n \\"ImageSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"Article\\": {\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"MediaId\\": \\"xx\\",\\n \\"FileUrl\\": \\"xx\\",\\n \\"TraceabilityId\\": \\"1\\"\\n }\\n ]\\n },\\n \\"TextSearchResult\\": {\\n \\"Current\\": 1,\\n \\"Size\\": 1,\\n \\"Total\\": 1,\\n \\"SearchResult\\": [\\n {\\n \\"DocId\\": \\"xx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"SearchSourceType\\": \\"SystemSearch\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"xxx\\",\\n \\"PubTime\\": \\"2024-11-25 14:25:59\\",\\n \\"Content\\": \\"xx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Title\\": \\"xx\\",\\n \\"Summary\\": \\"xx\\",\\n \\"TraceabilityId\\": \\"1\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"AudioSearchResult\\": {\\n \\"SearchResult\\": [\\n {\\n \\"MediaId\\": \\"xxx\\",\\n \\"FileUrl\\": \\"http://xxx\\",\\n \\"Article\\": {\\n \\"Title\\": \\"xx\\",\\n \\"Url\\": \\"http://xxx\\",\\n \\"Summary\\": \\"xxx\\",\\n \\"DocUuid\\": \\"xx\\",\\n \\"DocId\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"x\\"\\n ],\\n \\"CategoryUuid\\": \\"xx\\"\\n },\\n \\"ClipInfos\\": [\\n {\\n \\"Score\\": 0.9,\\n \\"From\\": 1,\\n \\"To\\": 2,\\n \\"Text\\": \\"xx\\",\\n \\"Type\\": \\"asr\\"\\n }\\n ],\\n \\"TraceabilityId\\": \\"1\\"\\n }\\n ]\\n }\\n },\\n \\"SearchKeywords\\": [\\n \\"xx\\"\\n ],\\n \\"SearchQueryList\\": [\\n \\"xx\\"\\n ],\\n \\"RecommendSearchQueryList\\": [\\n \\"xx\\"\\n ],\\n \\"SupplementDataType\\": \\"searchQuery\\",\\n \\"SupplementEnable\\": true,\\n \\"ModelId\\": \\"xx\\",\\n \\"TokenCalculate\\": {\\n \\"FirstTokenTime\\": 1,\\n \\"SearchTime\\": 1,\\n \\"OutputAvgTime\\": 1,\\n \\"Time\\": 1,\\n \\"TotalTokens\\": 1\\n },\\n \\"AskUser\\": \\"您想了解关于xx的哪些信息?\\",\\n \\"AskUserKeywords\\": [\\n \\"时间\\"\\n ]\\n }\\n },\\n \\"Messages\\": [\\n {\\n \\"Id\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"GenerateFinished\\": true,\\n \\"Clarifications\\": true,\\n \\"SearchQueries\\": [\\n \\"xx\\"\\n ],\\n \\"SearchResult\\": [\\n {\\n \\"MultimodalSearchQuery\\": \\"xx\\",\\n \\"Texts\\": [\\n {\\n \\"DocUuid\\": \\"xx\\"\\n }\\n ],\\n \\"Images\\": [\\n {\\n \\"MediaId\\": \\"xx\\"\\n }\\n ],\\n \\"Audios\\": [\\n {\\n \\"MediaId\\": \\"xx\\"\\n }\\n ],\\n \\"Videos\\": [\\n {\\n \\"MediaId\\": \\"1\\"\\n }\\n ]\\n }\\n ],\\n \\"NodeCode\\": \\"generateStartStatement\\",\\n \\"SearchQuery\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"OutputTokens\\": 2,\\n \\"InputTokens\\": 1,\\n \\"TotalTokens\\": 3\\n }\\n },\\n \\"Header\\": {\\n \\"SessionId\\": \\"x\\",\\n \\"TraceId\\": \\"xx\\",\\n \\"TaskId\\": \\"x\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"EventInfo\\": \\"xx\\",\\n \\"ResponseTime\\": 1\\n },\\n \\"RequestId\\": \\"xx\\"\\n}","type":"json"}]',
],
'RunSearchSimilarArticles' => [
- 'summary' => '妙搜-文搜文。',
'path' => '/quanmiao/aimiaosou/runSearchSimilarArticles',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -37856,22 +22576,12 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'none',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
'name' => 'ChatConfig',
@@ -37892,27 +22602,12 @@
'description' => '搜索源',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '搜索源类型:'."\n"
- .'- SystemSearch:系统内置搜索'."\n"
- .'- CustomSemanticSearch:自建语义索引搜索'."\n"
- .'- ThirdSearch:三方API搜索',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SystemSearch',
- ],
- 'Name' => [
- 'description' => '搜索源名称(非必选)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '互联网搜索',
- ],
- 'DatasetName' => [
- 'description' => '搜索源唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'QuarkCommonNews',
- ],
+ 'Code' => ['description' => '搜索源类型:'."\n"
+ .'- SystemSearch:系统内置搜索'."\n"
+ .'- CustomSemanticSearch:自建语义索引搜索'."\n"
+ .'- ThirdSearch:三方API搜索', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch'],
+ 'Name' => ['description' => '搜索源名称(非必选)', 'type' => 'string', 'required' => false, 'example' => '互联网搜索'],
+ 'DatasetName' => ['description' => '搜索源唯一标识', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
],
'required' => false,
],
@@ -37921,102 +22616,38 @@
'CategoryUuids' => [
'description' => '类目唯一标识',
'type' => 'array',
- 'items' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
],
'Tags' => [
'description' => '标签名称',
'type' => 'array',
- 'items' => [
- 'description' => '标签名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'required' => false,
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
- 'example' => 'xx',
- ],
- 'CreateTimeStart' => [
- 'description' => '起始创建时间。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- 'CreateTimeEnd' => [
- 'description' => '截止创建时间,时间戳形式。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
- ],
- 'StartTime' => [
- 'description' => '开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1725983999999',
- ],
- 'EndTime' => [
- 'description' => '结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '111',
],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'CreateTimeStart' => ['description' => '起始创建时间。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'CreateTimeEnd' => ['description' => '截止创建时间,时间戳形式。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
+ 'StartTime' => ['description' => '开始时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1725983999999'],
+ 'EndTime' => ['description' => '结束时间', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111'],
'DocUuids' => [
'description' => '文档唯一标识',
'type' => 'array',
- 'items' => [
- 'description' => '文档唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '文档唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
],
'DocIds' => [
'description' => '文档ID',
'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xx',
- ],
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'required' => false, 'example' => 'xx'],
'required' => false,
],
'DocTypes' => [
'description' => '文档类型:text image video audio pdf word ppt等',
'type' => 'array',
- 'items' => [
- 'description' => '文档类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'text',
- ],
+ 'items' => ['description' => '文档类型', 'type' => 'string', 'required' => false, 'example' => 'text'],
'required' => false,
],
],
@@ -38029,37 +22660,21 @@
[
'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'description' => '文章标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标题',
- ],
+ 'schema' => ['description' => '文章标题', 'type' => 'string', 'required' => false, 'example' => '标题'],
],
[
'name' => 'DocType',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'html',
- ],
+ 'schema' => ['description' => '文档类型', 'type' => 'string', 'required' => false, 'example' => 'html'],
],
[
'name' => 'Url',
'in' => 'formData',
- 'schema' => [
- 'description' => '文章地址',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'https://xxx/xxx',
- ],
+ 'schema' => ['description' => '文章地址', 'type' => 'string', 'required' => true, 'example' => 'https://xxx/xxx'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'BaseLlmResponse',
'description' => 'BaseLlmResponse',
@@ -38070,36 +22685,12 @@
'description' => '响应头',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '错误码',
- ],
- 'ErrorMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '错误信息',
- ],
- 'Event' => [
- 'title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'SessionId' => [
- 'title' => '会话ID',
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'EventInfo' => ['type' => 'string'],
],
],
'Payload' => [
@@ -38112,12 +22703,7 @@
'description' => '输出',
'type' => 'object',
'properties' => [
- 'Text' => [
- 'title' => '文本生成结果',
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
'Articles' => [
'description' => '文章列表',
'type' => 'array',
@@ -38125,97 +22711,33 @@
'description' => '文章',
'type' => 'object',
'properties' => [
- 'DocUuid' => [
- 'description' => '文章id',
- 'type' => 'string',
- 'example' => 'a26c2c1',
- ],
- 'SearchSourceName' => [
- 'description' => '搜索源名称',
- 'type' => 'string',
- 'example' => '互联网搜索',
- ],
- 'PubTime' => [
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2025-01-16 18:07:22',
- ],
- 'Source' => [
- 'description' => '文章来源',
- 'type' => 'string',
- 'example' => 'xxx.com',
- ],
- 'Title' => [
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '标题',
- ],
- 'Url' => [
- 'description' => '地址',
- 'type' => 'string',
- 'example' => 'https://xxx',
- ],
- 'Summary' => [
- 'description' => '摘要',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'DocId' => [
- 'description' => '文档-自定义的唯一ID',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'CategoryUuid' => [
- 'description' => '类目唯一标识',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend1' => [
- 'description' => '扩展字段1',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend2' => [
- 'description' => '扩展字段2',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'Extend3' => [
- 'description' => '扩展字段3',
- 'type' => 'string',
- 'example' => 'xx',
- ],
+ 'DocUuid' => ['description' => '文章id', 'type' => 'string', 'example' => 'a26c2c1'],
+ 'SearchSourceName' => ['description' => '搜索源名称', 'type' => 'string', 'example' => '互联网搜索'],
+ 'PubTime' => ['description' => '发布时间', 'type' => 'string', 'example' => '2025-01-16 18:07:22'],
+ 'Source' => ['description' => '文章来源', 'type' => 'string', 'example' => 'xxx.com'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => '标题'],
+ 'Url' => ['description' => '地址', 'type' => 'string', 'example' => 'https://xxx'],
+ 'Summary' => ['description' => '摘要', 'type' => 'string', 'example' => 'xxx'],
+ 'DocId' => ['description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => 'xxx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
'Tags' => [
'description' => '标签',
'type' => 'array',
- 'items' => [
- 'description' => '标签',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- ],
- 'SearchSource' => [
- 'description' => '搜索源',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'SearchSourceType' => [
- 'description' => '数据集类型',
- 'type' => 'string',
- 'example' => 'xx',
- ],
- 'DocType' => [
- 'description' => '文档类型:'."\n"
- .'- plainText:纯文本,content必选'."\n"
- .'- richText:富文本:html,content必选'."\n"
- .'- text:文本文件,url必选'."\n"
- .'- pdf:url必选'."\n"
- .'- word:url必选'."\n"
- .'- image:图片,url必选,支持gif、png、jpg、jpeg等大多数常见图片格式'."\n"
- .'- video:视频,url必选,支持MP4、AVI、WMV、MOV等大多数常见视频格式',
- 'type' => 'string',
- 'example' => 'text',
+ 'items' => ['description' => '标签', 'type' => 'string', 'example' => 'xx'],
],
+ 'SearchSource' => ['description' => '搜索源', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceType' => ['description' => '数据集类型', 'type' => 'string', 'example' => 'xx'],
+ 'DocType' => ['description' => '文档类型:'."\n"
+ .'- plainText:纯文本,content必选'."\n"
+ .'- richText:富文本:html,content必选'."\n"
+ .'- text:文本文件,url必选'."\n"
+ .'- pdf:url必选'."\n"
+ .'- word:url必选'."\n"
+ .'- image:图片,url必选,支持gif、png、jpg、jpeg等大多数常见图片格式'."\n"
+ .'- video:视频,url必选,支持MP4、AVI、WMV、MOV等大多数常见视频格式', 'type' => 'string', 'example' => 'text'],
],
],
],
@@ -38228,417 +22750,51 @@
.'none:镜像处于闲置状态,暂无ECS实例使用。',
'type' => 'object',
'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '81',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '9',
- ],
- 'TotalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '50',
- ],
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '81'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '9'],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '50'],
],
],
],
],
- 'RequestId' => [
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'RequestId' => ['description' => '请求Id', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\",\\n \\"Articles\\": [\\n {\\n \\"DocUuid\\": \\"a26c2c1\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2025-01-16 18:07:22\\",\\n \\"Source\\": \\"xxx.com\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"https://xxx\\",\\n \\"Summary\\": \\"xxx\\",\\n \\"DocId\\": \\"xxx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"DocType\\": \\"text\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 81,\\n \\"OutputTokens\\": 9,\\n \\"TotalTokens\\": 50\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
+ 'staticInfo' => ['returnType' => 'synchronous'],
'title' => '妙搜-文搜文',
- ],
- 'ListInterveneCnt' => [
- 'summary' => '获得干预项目数量列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页面尺寸',
- 'description' => '页面尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- [
- 'name' => 'PageIndex',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetIntervenesCntListResult>',
- 'description' => 'PlainResult<GetIntervenesCntListResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'CntList' => [
- 'title' => '数量信息列表',
- 'description' => '数量信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '分类数量信息',
- 'type' => 'any',
- 'example' => '{'."\n"
- .'"namespace":"namespace_qa_query", '."\n"
- .'"interfereType":0,'."\n"
- .'"cnt": 10'."\n"
- .'}',
- ],
- ],
- 'PageCnt' => [
- 'title' => '总页数',
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'PageIndex' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页尺寸',
- 'description' => '页尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Code' => [
- 'description' => '干预服务状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"CntList\\": [\\n \\"{\\\\n\\\\\\"namespace\\\\\\":\\\\\\"namespace_qa_query\\\\\\", \\\\n\\\\\\"interfereType\\\\\\":0,\\\\n\\\\\\"cnt\\\\\\": 10\\\\n}\\"\\n ],\\n \\"PageCnt\\": 10,\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获得所有干预项的数量',
- ],
- 'ListIntervenes' => [
- 'summary' => '获得干预项列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
+ 'summary' => '妙搜-文搜文。',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'parameters' => [
+ 'ramActions' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public',
- ],
- ],
- [
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '规则id',
- 'description' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => 'mqtt_outRule_1679019634514',
- ],
- ],
- [
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '问题',
- 'description' => '问题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '小猫',
- ],
- ],
- [
- 'name' => 'InterveneType',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '干预类型',
- 'description' => '干预类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '0-相似问干预项目' => '0-相似问干预项目',
- '2-正则表达式干预项 ' => '2-正则表达式干预项 ',
- ' 1-关键词表达式干预项 ' => ' 1-关键词表达式干预项 ',
- '3-关键词库干预项' => '3-关键词库干预项',
- ' 4-URL干预' => ' 4-URL干预',
- ],
- 'example' => '干预类型',
- ],
- ],
- [
- 'name' => 'PageIndex',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页面尺寸',
- 'description' => '页面尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetInterveneListResult>',
- 'description' => 'PlainResult<GetInterveneListResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'InterveneList' => [
- 'title' => '干预项列表',
- 'description' => '干预项列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'example' => '36559',
- ],
- 'Query' => [
- 'title' => '干预query',
- 'description' => '干预query',
- 'type' => 'string',
- 'example' => '伊家楼',
- ],
- ],
- ],
- ],
- 'PageIndex' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页尺寸',
- 'description' => '页尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'TotalSize' => [
- 'title' => '总页书',
- 'description' => '总页书',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunSearchSimilarArticles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"InterveneList\\": [\\n {\\n \\"Id\\": \\"36559\\",\\n \\"Query\\": \\"伊家楼\\"\\n }\\n ],\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalSize\\": 1,\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '列出干预项',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"EventInfo\\": \\"\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\",\\n \\"Articles\\": [\\n {\\n \\"DocUuid\\": \\"a26c2c1\\",\\n \\"SearchSourceName\\": \\"互联网搜索\\",\\n \\"PubTime\\": \\"2025-01-16 18:07:22\\",\\n \\"Source\\": \\"xxx.com\\",\\n \\"Title\\": \\"标题\\",\\n \\"Url\\": \\"https://xxx\\",\\n \\"Summary\\": \\"xxx\\",\\n \\"DocId\\": \\"xxx\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"DocType\\": \\"text\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 81,\\n \\"OutputTokens\\": 9,\\n \\"TotalTokens\\": 50\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
],
- 'ImportInterveneFile' => [
- 'summary' => '导入干预文件。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunStepByStepWriting' => [
+ 'path' => '/quanmiao/miaobi/runStepByStepWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -38646,1394 +22802,203 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'DocName',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '上传文件名字',
- 'description' => '上传文件名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'import.xls',
- ],
- ],
- [
- 'name' => 'FileUrl',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件地址',
- 'description' => '文件地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/xxx.xls',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'FileKey',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件osskey',
- 'description' => '文件osskey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'import.xsl',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<OperationResult>',
- 'description' => 'PlainResult<OperationResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'FailIdList' => [
- 'title' => '失败的索引id列表',
- 'description' => '失败的索引id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '失败干预项Id',
- 'type' => 'string',
- 'example' => '123456',
- ],
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '"3f7045e099474ba28ceca1b4eb6d6e21"',
- ],
- 'Code' => [
- 'description' => '干预状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"123456\\"\\n ],\\n \\"TaskId\\": \\"\\\\\\"3f7045e099474ba28ceca1b4eb6d6e21\\\\\\"\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '同步导入干预项文件',
- ],
- 'InsertInterveneGlobalReply' => [
- 'summary' => '设置干预全局回复。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxx_efm',
- ],
+ 'schema' => ['title' => '提示词', 'description' => '提示词', 'type' => 'string', 'required' => true, 'example' => '提示词'],
],
[
- 'name' => 'ReplyMessagList',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '回复内容列表',
- 'description' => '回复内容列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '回复内容',
- 'description' => '回复内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '抱歉,问题我无法回答',
- ],
- 'ReplyType' => [
- 'title' => '回复类型',
- 'description' => '回复类型',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)',
- 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)',
- 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)',
- ],
- 'example' => '全局回复的类型',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务ID,多轮对话可复用同一轮任务ID', 'description' => '任务ID,多轮对话可复用同一轮任务ID'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<OperationResult>',
- 'description' => 'PlainResult<OperationResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'FailIdList' => [
- 'title' => '失败的索引id列表',
- 'description' => '失败的索引id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '错误Id',
- 'type' => 'string',
- 'example' => '1234',
- ],
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '4829',
- ],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"1234\\"\\n ],\\n \\"TaskId\\": \\"4829\\",\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '插入干预全局回复项',
- ],
- 'ImportInterveneFileAsync' => [
- 'summary' => '异步导入干预文件。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
- ],
- [
- 'name' => 'DocName',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '上传文件名字',
- 'description' => '上传文件名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'import.xls',
- ],
+ 'schema' => ['title' => '单轮对话的ID', 'description' => '单轮对话的ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'FileUrl',
+ 'name' => 'OriginSessionId',
'in' => 'formData',
- 'schema' => [
- 'title' => '文件地址',
- 'description' => '文件地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://xxx/import.xls',
- ],
+ 'schema' => ['title' => '重新生成时原始对话的ID', 'description' => '重新生成时原始对话的ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'FileKey',
+ 'name' => 'WritingConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '文件osskey',
- 'description' => '文件osskey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'import.xls',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<OperationResult>',
- 'description' => 'PlainResult<OperationResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'FailIdList' => [
- 'title' => '失败的索引id列表',
- 'description' => '失败的索引id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '失败的干预项id',
- 'type' => 'string',
- 'example' => '123',
- ],
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Code' => [
- 'description' => '干预服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"123\\"\\n ],\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '异步导入干预项文件',
- ],
- 'GetInterveneTemplateFileUrl' => [
- 'summary' => '获得干预导入模版文件下载地址。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetTemplateFileUrlResult>',
- 'description' => 'PlainResult<GetTemplateFileUrlResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'FileUrl' => [
- 'title' => '模版文件地址',
- 'description' => '模版文件地址',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.xls',
- ],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://xxx/xxx.xls\\",\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获得干预导入模版文件地址',
- ],
- 'ClearIntervenes' => [
- 'summary' => '清除所有干预内容。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<OperationResult>',
- 'description' => 'PlainResult<OperationResult>',
+ 'title' => '写作配置',
+ 'description' => '写作配置',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'FailIdList' => [
- 'title' => '失败的索引id列表',
- 'description' => '失败的索引id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '失败的干预项Id',
- 'type' => 'string',
- 'example' => '"1234"',
- ],
- ],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Code' => [
- 'description' => '干预服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
+ 'Domain' => [
+ 'title' => '写作领域:media(默认):传媒写作,government:公文写作',
+ 'description' => '写作领域'."\n"
+ ."\n"
+ .'- media(默认):传媒写作'."\n"
+ ."\n"
+ .'- government:公文写作',
'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'required' => false,
+ 'example' => 'media',
+ 'enum' => ['media', 'government'],
],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"\\\\\\"1234\\\\\\"\\"\\n ],\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '清除所有干预项',
- ],
- 'GetInterveneGlobalReply' => [
- 'summary' => '获得干预全局回复。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetGlobalReplyResult>',
- 'description' => 'PlainResult<GetGlobalReplyResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
+ 'Keywords' => [
+ 'title' => '关键词(影响文章检索)',
+ 'description' => '关键词(影响文章检索)',
+ 'type' => 'array',
+ 'items' => ['description' => '关键词(string)', 'type' => 'string', 'required' => false, 'example' => '关键词'],
+ 'required' => false,
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'PromptTag' => [
+ 'title' => '提示词小助手',
+ 'description' => '提示词小助手',
'type' => 'object',
'properties' => [
- 'ReplyMessagList' => [
- 'title' => '回复信息列表',
- 'description' => '回复信息列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Message' => [
- 'title' => '回复内容',
- 'description' => '回复内容',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ReplyType' => [
- 'title' => '回复类型',
- 'description' => '回复类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)',
- 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)',
- 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)',
- ],
- 'example' => 'namespace_qa_query',
- ],
- ],
- ],
- ],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'NecessaryTips' => ['title' => '必要提示', 'description' => '必要提示', 'type' => 'string', 'required' => false, 'example' => '必要提示'],
+ 'Position' => ['title' => '立场', 'description' => '立场', 'type' => 'string', 'required' => false, 'example' => '立场'],
+ 'ReverseWords' => ['title' => '反向词', 'description' => '反向词', 'type' => 'string', 'required' => false, 'example' => '反向词'],
+ 'Theme' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'required' => false, 'example' => '主题'],
],
+ 'required' => false,
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"ReplyMessagList\\": [\\n {\\n \\"Message\\": \\"success\\",\\n \\"ReplyType\\": \\"namespace_qa_query\\"\\n }\\n ],\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获得干预全局回复内容',
- ],
- 'ListInterveneRules' => [
- 'summary' => '获得干预规则列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
- ],
- [
- 'name' => 'PageIndex',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页面尺寸',
- 'description' => '页面尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetInterveneRuleListResult>',
- 'description' => 'PlainResult<GetInterveneRuleListResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
+ 'Scene' => ['title' => '分步骤写作场景,传媒写作支持的写作场景:新闻写作(默认),新闻评论,通用文体,公文写作支持的写作场景:通知(默认),通告,通报,请示,决定,函,通用文体', 'description' => '分步骤写作场景'."\n"
+ ."\n"
+ .'- 传媒写作支持的写作场景:新闻写作(默认)、新闻评论、通用文体'."\n"
+ ."\n"
+ .'- 公文写作支持的写作场景:通知(默认)、通告、通报、请示、决定、函、通用文体', 'type' => 'string', 'required' => false, 'example' => '新闻写作'],
+ 'Step' => [
+ 'title' => '写作步骤-生成大纲:OutlineGenerate、生成摘编:MiniDocSummary,Writing(默认):生成文章',
+ 'description' => '写作步骤'."\n"
+ ."\n"
+ .'- 生成大纲:OutlineGenerate'."\n"
+ ."\n"
+ .'- 生成摘编:MiniDocSummary'."\n"
+ ."\n"
+ .'- Writing(默认):生成文章',
'type' => 'string',
- 'example' => 'success',
+ 'required' => false,
+ 'example' => 'Writing',
+ 'enum' => ['OutlineGenerate', 'MiniDocSummary', 'Writing'],
],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'Count' => [
- 'title' => '数量',
- 'description' => '数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'InterveneRuleList' => [
- 'title' => '规则列表',
- 'description' => '规则列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '规则描述',
- 'type' => 'object',
- 'properties' => [
- 'AnswerConfig' => [
- 'title' => '答案配置',
- 'description' => '答案配置',
- 'type' => 'array',
- 'items' => [
- 'description' => '答案配置项',
- 'type' => 'object',
- 'properties' => [
- 'AnswerType' => [
- 'title' => '答案类型',
- 'description' => '答案类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '0-统一回复' => '0-统一回复',
- '1-定向回复 ' => '1-定向回复 ',
- ],
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '答案内容',
- 'description' => '答案内容',
- 'type' => 'string',
- 'example' => '抱歉我无法回答',
- ],
- 'Namespace' => [
- 'title' => '命名空间',
- 'description' => '命名空间',
- 'type' => 'string',
- 'example' => 'namespace_qa_query',
- ],
- ],
- ],
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-06-05 15:17:01',
- ],
- 'EffectTime' => [
- 'title' => '生效时间',
- 'description' => '生效时间',
- 'type' => 'string',
- 'example' => '2023-04-03 02:42:01',
- ],
- 'InterveneType' => [
- 'title' => '干预类型',
- 'description' => '干预类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '0-永久生效' => '0-永久生效',
- '1-按时间生效' => '1-按时间生效',
- ],
- 'example' => '0',
- ],
- 'NamespaceList' => [
- 'title' => '命名空间列表',
- 'description' => '命名空间列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '干预范围',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)',
- 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)',
- 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)',
- ],
- 'example' => 'namespace_qa_query',
- ],
- ],
- 'RuleId' => [
- 'title' => '规则id',
- 'description' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => 'mr-iuo9pi9w555phfbb',
- ],
- 'RuleName' => [
- 'title' => '规则名字',
- 'description' => '规则名字',
- 'type' => 'string',
- 'example' => 'ruletest',
- ],
- ],
- ],
- ],
- 'PageIndex' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页尺寸',
- 'description' => '页尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Code' => [
- 'description' => '干预服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'Tags' => [
+ 'title' => '写作时的文体、篇幅、输出语言等控制参数',
+ 'description' => '写作时的文体、篇幅、输出语言等控制参数',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '标签对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Keyword' => ['title' => '选项的值', 'description' => '选项的值', 'type' => 'string', 'required' => false, 'example' => '10'],
+ 'Tag' => ['title' => '选项的Tag。例如 gcNumberSizeTag=10', 'description' => '选项的Tag。例如 gcNumberSizeTag=10', 'type' => 'string', 'required' => false, 'example' => 'gcNumberSizeTag'],
],
+ 'required' => false,
],
+ 'required' => false,
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'UseSearch' => ['title' => '是否自动补充素材', 'description' => '是否自动补充素材', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'SummaryReturnType' => ['title' => '摘编结果的返回类型(枚举值:Structure、Content、Event)'."\n"
+ .'Structure:表示在 payload.output.text中返回json字符串:{"event":"{outline}","message":"{message}"}'."\n"
+ ."\n"
+ .'Content: 表示在 payload.output.text中返回纯文本的摘编内容:大纲:{outline}\\n\\n{message}\\n\\n\\n大纲:{outline}\\n\\n{message}'."\n"
+ ."\n"
+ .'Event: 表示 仅在每次大纲写完时,在 payload.output.text中 返回大纲 {outline} 信息。如果有六个大纲需要写,则会返回六条大纲信息', 'description' => '摘编结果的返回类型:<br/>'."\n"
+ .'- Structure:'."\n"
+ .' 表示在 payload.output.text中返回json字符串。示例格式:```{"event":"{outline}","message":"{message}"}```'."\n"
+ .'- Content: 仅在 payload.output.text中返回纯文本的摘编内容。示例格式:'."\n"
+ .' ```大纲:{outline}\\n\\n{message}\\n\\n\\n大纲:{outline}\\n\\n{message}```'."\n"
+ ."\n"
+ .'- Event: 仅在每次大纲写完时,在 payload.output.text中 返回大纲内容本身。一般会返回六条大纲', 'type' => 'string', 'required' => false, 'example' => 'Structure'],
],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"Count\\": 1,\\n \\"InterveneRuleList\\": [\\n {\\n \\"AnswerConfig\\": [\\n {\\n \\"AnswerType\\": 0,\\n \\"Message\\": \\"抱歉我无法回答\\",\\n \\"Namespace\\": \\"namespace_qa_query\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-06-05 15:17:01\\",\\n \\"EffectTime\\": \\"2023-04-03 02:42:01\\",\\n \\"InterveneType\\": 0,\\n \\"NamespaceList\\": [\\n \\"namespace_qa_query\\"\\n ],\\n \\"RuleId\\": 0,\\n \\"RuleName\\": \\"ruletest\\"\\n }\\n ],\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '列出干预规则',
- ],
- 'ListInterveneImportTasks' => [
- 'summary' => '获得导入任务列表。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'PageIndex',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- ],
- [
- 'name' => 'PageSize',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '每页尺寸',
- 'description' => '每页尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
'required' => false,
- 'example' => '20',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<OperationStatusListResult>',
- 'description' => 'PlainResult<OperationStatusListResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'PageIndex' => [
- 'title' => '页号',
- 'description' => '页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'PageSize' => [
- 'title' => '页尺寸',
- 'description' => '页尺寸',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'StatusList' => [
- 'title' => '任务状态信息',
- 'description' => '任务状态信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Msg' => [
- 'title' => '任务信息',
- 'description' => '任务信息',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'Percentage' => [
- 'title' => '完成百分比',
- 'description' => '完成百分比',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'Success',
- ],
- 'TaskId' => [
- 'title' => '任务Id',
- 'description' => '任务Id',
- 'type' => 'string',
- 'example' => '4854',
- ],
- 'TaskName' => [
- 'title' => '任务名字',
- 'description' => '任务名字',
- 'type' => 'string',
- 'example' => '12344454',
- ],
- ],
- ],
- ],
- 'TotalSize' => [
- 'title' => '总页数',
- 'description' => '总页数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'Code' => [
- 'description' => '干预服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
],
],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"PageIndex\\": 1,\\n \\"PageSize\\": 10,\\n \\"StatusList\\": [\\n {\\n \\"Msg\\": \\"Success\\",\\n \\"Percentage\\": 5,\\n \\"Status\\": 0,\\n \\"TaskId\\": \\"4854\\",\\n \\"TaskName\\": \\"12344454\\"\\n }\\n ],\\n \\"TotalSize\\": 0,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '列出干预项导入任务',
- ],
- 'InsertInterveneRule' => [
- 'summary' => '插入干预规则。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
- ],
- ],
- [
- 'name' => 'InterveneRuleConfig',
+ 'name' => 'ReferenceData',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'title' => '干预规则配置',
- 'description' => '干预规则配置',
+ 'title' => '写作时的参考文章数据',
+ 'description' => '写作时的参考文章数据',
'type' => 'object',
'properties' => [
- 'AnswerConfig' => [
- 'title' => '答案配置',
- 'description' => '答案配置',
+ 'Articles' => [
+ 'title' => '写作时的参考文章数据',
+ 'description' => '写作时的参考文章数据',
'type' => 'array',
'items' => [
- 'description' => '答案配置项',
+ 'description' => '写作时的参考文章数据',
'type' => 'object',
'properties' => [
- 'AnswerType' => [
- 'title' => '答案类型',
- 'description' => '答案类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '1-定向回复' => '1-定向回复',
- ' 0-统一回复' => ' 0-统一回复',
- ],
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '答案内容',
- 'description' => '答案内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '抱歉我无法回答',
- ],
- 'Namespace' => [
- 'title' => '命名空间',
- 'description' => '命名空间',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- ' namespace_writing_query (写作输入干预)' => ' namespace_writing_query (写作输入干预)',
- ' namespace_qa_result (问答结果干预)' => ' namespace_qa_result (问答结果干预)',
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- ' namespace_writing_result (写作结果干预)' => ' namespace_writing_result (写作结果干预)',
- ],
- 'example' => 'namespace_qa_query',
- ],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'required' => false, 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'required' => false, 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'required' => false, 'example' => '8a20e007a6174522af4d6a2657d5526f'],
+ 'MediaUrl' => ['description' => '原始素材地址', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'required' => false, 'example' => '2024-09-10 14:17:54'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'required' => false, 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'required' => false, 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'required' => false, 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'],
],
'required' => false,
],
'required' => false,
],
- 'EffectConfig' => [
- 'title' => '生效配置',
- 'description' => '生效配置',
- 'type' => 'object',
- 'properties' => [
- 'EffectType' => [
- 'title' => '生效类型',
- 'description' => '生效类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '0-永久生效 ' => '0-永久生效 ',
- '1-按时间生效' => '1-按时间生效',
- ],
- 'example' => '0',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-28 06:04:29',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-28 06:04:29',
- ],
- ],
+ 'MiniDoc' => [
+ 'title' => '排序Rank后的文章片段(用于后续模型生成)',
+ 'description' => '排序Rank后的文章片段(用于后续模型生成)',
+ 'type' => 'array',
+ 'items' => ['description' => '文章片段', 'type' => 'string', 'required' => false, 'example' => '文章片段'],
'required' => false,
],
- 'InterveneConfigList' => [
- 'title' => '干预配置列表',
- 'description' => '干预配置列表',
+ 'Outlines' => [
+ 'title' => '大纲(可以指定数据源生成大纲)',
+ 'description' => '大纲(可以指定数据源生成大纲)',
'type' => 'array',
'items' => [
+ 'description' => '大纲',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => 'id',
- 'description' => 'id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '37249',
- ],
- 'OperationType' => [
- 'title' => '操作类型',
- 'description' => '操作类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '0-新建' => '0-新建',
- ' 1-更新 ' => ' 1-更新 ',
- '2-删除' => '2-删除',
+ 'Articles' => [
+ 'title' => '指定大纲数据源',
+ 'description' => '指定大纲数据源',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '文章内容', 'description' => '文章内容', 'type' => 'string', 'required' => false, 'example' => '文章内容'],
+ 'Title' => ['title' => '文章标题', 'description' => '文章标题', 'type' => 'string', 'required' => false, 'example' => '文章标题'],
+ 'Url' => ['title' => '文章链接', 'description' => '文章链接', 'type' => 'string', 'required' => false, 'example' => '文章链接'],
+ ],
+ 'required' => false,
],
- 'example' => '0',
- ],
- 'Query' => [
- 'title' => '干预query配置',
- 'description' => '干预query配置',
- 'type' => 'string',
'required' => false,
- 'example' => '早上好',
],
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'required' => false, 'example' => '大纲'],
],
'required' => false,
],
'required' => false,
],
- 'InterveneType' => [
- 'title' => '干预类型',
- 'description' => '干预类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'enumValueTitles' => [
- '0-相似问干预项目' => '0-相似问干预项目',
- ' 2-正则表达式干预项 ' => ' 2-正则表达式干预项 ',
- '3-关键词库干预项' => '3-关键词库干预项',
- ' 4-URL干预' => ' 4-URL干预',
- '1-关键词表达式干预项' => '1-关键词表达式干预项',
- ],
- 'example' => '0',
- ],
- 'NamespaceList' => [
- 'title' => '命名空间列表',
- 'description' => '命名空间列表',
+ 'Summarization' => [
+ 'title' => '大模型摘编总结结果',
+ 'description' => '大模型摘编总结结果',
'type' => 'array',
- 'items' => [
- 'description' => '干预维度',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'namespace_writing_image (智能配图)' => 'namespace_writing_image (智能配图)',
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- 'namespace_qa_article (问答参考)' => 'namespace_qa_article (问答参考)',
- 'namespace_writing_article (写作参考)' => 'namespace_writing_article (写作参考)',
- 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)',
- 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)',
- 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)',
- ],
- 'example' => 'namespace_qa_query'."\n"
- .'(问答输入干预)',
- ],
+ 'items' => ['description' => '摘编结果(模型上下文)', 'type' => 'string', 'required' => false, 'example' => '摘编结果(模型上下文)'],
'required' => false,
],
- 'RuleId' => [
- 'title' => '规则Id',
- 'description' => '规则Id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '2',
- ],
- 'RuleName' => [
- 'title' => '规则名字',
- 'description' => '规则名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tf-test-rule',
- ],
],
'required' => false,
],
@@ -40041,310 +23006,135 @@
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<InsertInterveneRuleResult>',
- 'description' => 'PlainResult<InsertInterveneRuleResult>',
+ 'title' => 'BaseLlmResponse',
+ 'description' => 'BaseLlmResponse',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Header' => [
+ 'title' => '响应头',
+ 'description' => '响应头',
'type' => 'object',
'properties' => [
- 'RuleId' => [
- 'title' => '规则id',
- 'description' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '12345',
- ],
- 'Code' => [
- 'description' => '干预服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
- ],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"RuleId\\": 12345,\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"DD656AF9-0839-521A-A3D2-F320009F9C87\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '插入干预规则',
- ],
- 'GetInterveneRuleDetail' => [
- 'summary' => '获得干预项规则详情。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm',
- ],
- ],
- [
- 'name' => 'RuleId',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '规则id',
- 'description' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '12345',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetInterveneRuleDetailResult>',
- 'description' => 'PlainResult<GetInterveneRuleDetailResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'InterveneRuleDetail' => [
- 'title' => '规则详情结构',
- 'description' => '规则详情结构',
+ 'Output' => [
+ 'title' => '输出',
+ 'description' => '输出',
'type' => 'object',
'properties' => [
- 'AnswerConfig' => [
- 'title' => '答案信息配置',
- 'description' => '答案信息配置',
+ 'Articles' => [
+ 'title' => '参照文章',
+ 'description' => '参照文章',
'type' => 'array',
'items' => [
+ 'description' => '参照文章',
'type' => 'object',
'properties' => [
- 'AnswerType' => [
- 'title' => '答案类型',
- 'description' => '答案类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '0-统一回复' => '0-统一回复',
- '1-定向回复 ' => '1-定向回复 ',
- ],
- 'example' => '0',
- ],
- 'Message' => [
- 'title' => '答案内容',
- 'description' => '答案内容',
- 'type' => 'string',
- 'example' => '早上好',
- ],
- 'Namespace' => [
- 'title' => '命名空间',
- 'description' => '命名空间',
- 'type' => 'string',
- 'enumValueTitles' => [
- ' namespace_writing_query (写作输入干预)' => ' namespace_writing_query (写作输入干预)',
- ' namespace_qa_result (问答结果干预)' => ' namespace_qa_result (问答结果干预)',
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- ' namespace_writing_result (写作结果干预)' => ' namespace_writing_result (写作结果干预)',
- ],
- 'example' => 'namespace_qa_query',
- ],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => 'f1da53894e784759946d22e2cb2b522a'],
+ 'MediaUrl' => ['description' => '原始素材地址', 'type' => 'string', 'example' => 'http://www.example.com'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-09-10 14:17:53'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
],
],
],
- 'EffectConfig' => [
- 'title' => '生效配置',
- 'description' => '生效配置',
+ 'ExtraOutput' => [
+ 'title' => '额外输出字段',
+ 'description' => '额外输出字段',
'type' => 'object',
'properties' => [
- 'EffectType' => [
- 'title' => '生效类型',
- 'description' => '生效类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '0-永久生效 ' => '0-永久生效 ',
- '1-按时间生效' => '1-按时间生效',
- ],
- 'example' => '0',
- ],
- 'EndTime' => [
- 'title' => '结束时间',
- 'description' => '结束时间',
- 'type' => 'string',
- 'example' => '2023-11-25 14:21:15',
- ],
- 'StartTime' => [
- 'title' => '开始时间',
- 'description' => '开始时间',
- 'type' => 'string',
- 'example' => '2023-11-25 14:21:15',
+ 'summarization' => [
+ 'title' => '摘编列表(分步骤生成摘编时,会返回该字段)',
+ 'description' => '摘编列表(分步骤生成摘编时,会返回该字段)',
+ 'type' => 'array',
+ 'items' => ['title' => '摘编字段', 'description' => '摘编字段', 'type' => 'string', 'example' => '摘编'],
],
],
],
- 'InterveneType' => [
- 'title' => '干预类型',
- 'description' => '干预类型',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '3-关键词库干预项 ' => '3-关键词库干预项 ',
- '0-相似问干预项目 ' => '0-相似问干预项目 ',
- ' 2-正则表达式干预项 ' => ' 2-正则表达式干预项 ',
- '4-URL干预' => '4-URL干预',
- '1-关键词表达式干预项' => '1-关键词表达式干预项',
- ],
- 'example' => '0',
- ],
- 'NamespaceList' => [
- 'title' => '命名空间列表',
- 'description' => '命名空间列表',
+ 'MiniDoc' => [
+ 'title' => '文章精排之后的片段列表',
+ 'description' => '文章精排之后的片段列表',
'type' => 'array',
- 'items' => [
- 'description' => '干预维度',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'namespace_writing_image (智能配图)' => 'namespace_writing_image (智能配图)',
- 'namespace_qa_query (问答输入干预)' => 'namespace_qa_query (问答输入干预)',
- 'namespace_qa_article (问答参考)' => 'namespace_qa_article (问答参考)',
- 'namespace_writing_article (写作参考)' => 'namespace_writing_article (写作参考)',
- 'namespace_qa_result (问答结果干预)' => 'namespace_qa_result (问答结果干预)',
- 'namespace_writing_result (写作结果干预)' => 'namespace_writing_result (写作结果干预)',
- 'namespace_writing_query (写作输入干预)' => 'namespace_writing_query (写作输入干预)',
- ],
- 'example' => 'namespace_qa_query',
- ],
- ],
- 'RuleId' => [
- 'title' => '规则id',
- 'description' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100418',
- ],
- 'RuleName' => [
- 'title' => '规则名字',
- 'description' => '规则名字',
- 'type' => 'string',
- 'example' => '规则001',
+ 'items' => ['title' => '文章精排之后的片段'."\n"
+ .' * ', 'description' => '文章精排之后的片段'."\n"
+ .' * ', 'type' => 'string', 'example' => '文章精排之后的片段'],
+ 'example' => '文章精排之后的片段',
],
+ 'SearchQuery' => ['title' => 'query改写结果', 'description' => 'query改写结果', 'type' => 'string', 'example' => '大模型改变世界'],
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
],
],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ 'Usage' => [
+ 'title' => 'Token用量信息',
+ 'description' => 'Token用量信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['title' => '输入Token数', 'description' => '输入Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '65'],
+ 'OutputTokens' => ['title' => '输出Token数', 'description' => '输出Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '80'],
+ 'TotalTokens' => ['title' => '总Token数', 'description' => '总Token数', 'type' => 'integer', 'format' => 'int64', 'example' => '32'],
+ ],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '唯一请求ID', 'description' => '唯一请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"InterveneRuleDetail\\": {\\n \\"AnswerConfig\\": [\\n {\\n \\"AnswerType\\": 0,\\n \\"Message\\": \\"早上好\\",\\n \\"Namespace\\": \\"namespace_qa_query\\"\\n }\\n ],\\n \\"EffectConfig\\": {\\n \\"EffectType\\": 0,\\n \\"EndTime\\": \\"2023-11-25 14:21:15\\",\\n \\"StartTime\\": \\"2023-11-25 14:21:15\\"\\n },\\n \\"InterveneType\\": 0,\\n \\"NamespaceList\\": [\\n \\"namespace_qa_query\\"\\n ],\\n \\"RuleId\\": 100418,\\n \\"RuleName\\": \\"规则001\\"\\n },\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获得干预规则的详情',
- ],
- 'DeleteInterveneRule' => [
- 'summary' => '删除干预规则。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '分步骤写作',
+ 'summary' => '使用大纲+摘编的分步骤的模式进行写作。',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-30T11:38:26.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunStepByStepWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"f1da53894e784759946d22e2cb2b522a\\",\\n \\"MediaUrl\\": \\"http://www.example.com\\",\\n \\"PubTime\\": \\"2024-09-10 14:17:53\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"ExtraOutput\\": {\\n \\"summarization\\": [\\n \\"摘编\\"\\n ]\\n },\\n \\"MiniDoc\\": [\\n \\"文章精排之后的片段\\"\\n ],\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 65,\\n \\"OutputTokens\\": 80,\\n \\"TotalTokens\\": 32\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
+ ],
+ 'RunStyleFeatureAnalysis' => [
+ 'path' => '/quanmiao/aimiaobi/runStyleFeatureAnalysis',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -40352,919 +23142,407 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间id', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
+ ],
+ [
+ 'name' => 'Contents',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxx_p_efm',
+ 'title' => '自定义内容文本集合',
+ 'description' => '自定义内容文本集合',
+ 'type' => 'array',
+ 'items' => ['title' => '自定义内容文本', 'description' => '自定义内容文本', 'type' => 'string', 'required' => false, 'example' => '生活是一种律动,须有光有影,有左有右,有晴有雨,趣味就在这变而不猛的曲折里,微微暗些,再明起来,则暗得有趣,而明乃更明。——老舍'],
+ 'required' => false,
],
],
[
- 'name' => 'RuleId',
+ 'name' => 'MaterialIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '规则id',
- 'description' => '规则id',
- 'type' => 'integer',
- 'format' => 'int64',
+ 'title' => '素材库ID集合',
+ 'description' => '素材库ID集合',
+ 'type' => 'array',
+ 'items' => ['title' => '素材库ID', 'description' => '素材库ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
'required' => false,
- 'example' => '12345',
],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<OperationResult>',
- 'description' => 'PlainResult<OperationResult>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
+ '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' => '模型生成事件'],
+ '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' => [
- 'FailIdList' => [
- 'title' => '失败的索引id列表',
- 'description' => '失败的索引id列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '失败的id列表',
- 'type' => 'string',
- 'example' => '12345',
+ 'Output' => [
+ 'title' => '输出内容对象',
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '输出内容', 'description' => '输出内容', 'type' => 'string', 'example' => '这是测试输出'],
],
],
- 'TaskId' => [
- 'title' => '任务id',
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => 'dt-s50ntwtywb4y',
- ],
- 'Code' => [
- 'description' => '干预服务返回的状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ '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'],
+ ],
],
],
],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求唯一ID', 'description' => '请求唯一ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"success\\",\\n \\"Data\\": {\\n \\"FailIdList\\": [\\n \\"12345\\"\\n ],\\n \\"TaskId\\": \\"dt-s50ntwtywb4y\\",\\n \\"Code\\": 200\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '删除干预规则',
- ],
- 'ExportIntervenes' => [
- 'summary' => '导出所有干预内容。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '内容特点分析',
+ 'summary' => '内容特点分析。',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fed6555ec9e24b92aeecc34be484b887_p_efm',
- ],
- ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<UrlResult>',
- 'description' => 'PlainResult<UrlResult>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'FileUrl' => [
- 'title' => '文件url',
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.xls',
- ],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- ],
- ],
- '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',
- ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunStyleFeatureAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"FileUrl\\": \\"http://xxx/xxx.xls\\",\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '导出干预项内容',
+ '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
],
- 'GetInterveneImportTaskInfo' => [
- 'summary' => '获得导入任务信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunSummaryGenerate' => [
+ 'summary' => '内容摘要生成。',
+ 'path' => '/quanmiao/aimiaobi/runSummaryGenerate',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public',
- ],
+ 'name' => 'WorkspaceId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '业务空间id', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务id',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
- 'required' => false,
- 'example' => '19162157',
- ],
+ 'schema' => ['title' => '需要生成摘要的内容', 'description' => '需要生成摘要的内容', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际,开发政务社交媒体的特色功能,如在线咨询服务、政策解读、互动问答等,增强政务社交媒体的互动性和实用性,提升公众参与度。'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'formData',
+ 'schema' => ['title' => '自定义摘要Prompt.', 'description' => '自定义摘要Prompt.', 'type' => 'string', 'required' => false, 'example' => '请为上述内容生成一段摘要,字数在100~200字以内。', 'default' => '请为上述内容生成一段摘要,字数在100~200字以内。'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult<GetImportTaskInfoResult>',
- 'description' => 'PlainResult<GetImportTaskInfoResult>',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => '0',
+ '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' => '模型生成事件'],
+ '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' => [
- 'Status' => [
- 'title' => '任务状态信息',
- 'description' => '任务状态信息',
+ 'Output' => [
+ 'title' => '输出内容对象',
+ 'description' => '输出内容对象',
'type' => 'object',
'properties' => [
- 'Msg' => [
- 'title' => '任务信息',
- 'description' => '任务信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Percentage' => [
- 'title' => '完成百分比',
- 'description' => '完成百分比',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '80',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'enumValueTitles' => [
- '3-超时' => '3-超时',
- '2-错误' => '2-错误',
- ' 1-进行中 ' => ' 1-进行中 ',
- '0-结束' => '0-结束',
- ],
- 'example' => '0',
- ],
- 'TaskId' => [
- 'title' => '任务Id',
- 'description' => '任务Id',
- 'type' => 'string',
- 'example' => '41405255',
- ],
- 'TaskName' => [
- 'title' => '任务名字',
- 'description' => '任务名字',
- 'type' => 'string',
- 'example' => 'ft-task-20190101m8rnK',
- ],
+ 'Text' => ['title' => '输出内容', 'description' => '输出内容', 'type' => 'string', 'example' => '这是测试输出'],
],
],
- 'Code' => [
- 'type' => 'integer',
- 'format' => 'int32',
+ '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'],
+ ],
],
],
],
- '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',
- ],
+ 'RequestId' => ['title' => '请求唯一ID', 'description' => '请求唯一ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"0\\",\\n \\"Data\\": {\\n \\"Status\\": {\\n \\"Msg\\": \\"success\\",\\n \\"Percentage\\": 80,\\n \\"Status\\": 0,\\n \\"TaskId\\": \\"41405255\\",\\n \\"TaskName\\": \\"ft-task-20190101m8rnK\\"\\n },\\n \\"Code\\": 0\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"Success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获得干预项目导入任务信息',
- ],
- 'SaveDataSourceOrderConfig' => [
- 'summary' => '保存用户写作信源配置,通用搜索信源配置的配置信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'operationType' => 'write',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '摘要生成',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'parameters' => [
- [
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'c160c841c8e54295bf2f441432785944_p_efm',
- ],
- ],
- [
- 'name' => 'ProductCode',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '产品类型 可选值 miaobi, miaosou',
- 'description' => '产品类型,可选值如下:'."\n"
- ."\n"
- .'- miaobi'."\n"
- ."\n"
- .'- miaosou',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'miaobi',
- 'enum' => [
- 'miaobi',
- 'miaosou',
- ],
- ],
- ],
- [
- 'name' => 'UserConfigDataSourceList',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '用户数据源配置',
- 'description' => '用户数据源配置',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => 'code描述',
- 'description' => 'code描述',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'QuarkCommonNews',
- ],
- 'Name' => [
- 'title' => '显示名称',
- 'description' => '显示名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '夸克通用搜索',
- ],
- 'Number' => [
- 'title' => '数量',
- 'description' => '数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '20',
- ],
- 'Type' => [
- 'title' => 'type类型',
- 'description' => 'type类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SystemSearch',
- ],
- 'Enable' => [
- 'title' => '是否启用',
- 'description' => '是否启用',
- 'type' => 'boolean',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- ],
- [
- 'name' => 'GenerateTechnology',
- 'in' => 'formData',
- 'schema' => [
- 'title' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
- .'取值:"copilotPrecise","copilotReference"',
- 'description' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
- ."\n"
- .'可选值如下:'."\n"
- ."\n"
- .'- copilotPrecise'."\n"
- ."\n"
- .'- copilotReference',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'copilotReference',
- ],
- ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<Boolean>',
- 'description' => 'PlainResult<Boolean>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunSummaryGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '保存信源权重配置',
+ '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 \\"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 \\"RequestId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\"\\n}","type":"json"}]',
],
- 'GetDataSourceOrderConfig' => [
- 'summary' => '获取写作信源,通用搜索信源的配置信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'RunTextPolishing' => [
+ 'path' => '/quanmiao/aimiaobi/runTextPolishing',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'AgentKey',
- 'in' => 'query',
- 'schema' => [
- 'title' => '业务空间唯一标识:AgentKey',
- 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'd9a1f6146a37446495d9985c2e7b267e_p_outbound_public',
- ],
- ],
- [
- 'name' => 'ProductCode',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '配置类型 可选值 miaobi、miaosou',
- 'description' => '配置类型。可选值如下:'."\n"
- ."\n"
- .'- miaobi'."\n"
- ."\n"
- .'- miaosou',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'miaobi',
- 'enum' => [
- 'miaobi',
- 'miaosou',
- ],
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'GenerateTechnology',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'title' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
- .'取值:"copilotPrecise","copilotReference"',
- 'description' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
- ."\n"
- .'可取值如下:'."\n"
- ."\n"
- .'- copilotPrecise'."\n"
- ."\n"
- .'- copilotReference',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'copilotPrecise',
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'description' => '成功',
- 'schema' => [
- 'title' => 'PlainResult<GetDataSourceOrderConfigResponse>',
- 'description' => 'PlainResult<GetDataSourceOrderConfigResponse>',
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Data' => [
- 'title' => '业务数据',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'UserConfigDataSourceList' => [
- 'title' => '用户配置数据源权重列表',
- 'description' => '用户配置数据源权重列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Code' => [
- 'title' => 'code描述',
- 'description' => 'code描述',
- 'type' => 'string',
- 'example' => 'QuarkCommonNews',
- ],
- 'Name' => [
- 'title' => '显示名称',
- 'description' => '显示名称',
- 'type' => 'string',
- 'example' => '夸克通用搜索',
- ],
- 'Number' => [
- 'title' => '数量',
- 'description' => '数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'Type' => [
- 'title' => 'type类型',
- 'description' => 'type类型',
- 'type' => 'string',
- 'example' => 'SystemSearch',
- ],
- 'Enable' => [
- 'title' => '是否启用',
- 'description' => '是否启用',
- 'type' => 'boolean',
- ],
- ],
- ],
- ],
- 'TotalDocSize' => [
- 'title' => '最大文档总数',
- 'description' => '最大文档总数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'HttpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'title' => '错误说明',
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => '请求唯一标识',
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- ],
- ],
+ 'schema' => ['title' => '待润色的文章段落', 'description' => '文本内容', 'type' => 'string', 'required' => true, 'example' => '文本内容'],
],
- ],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"UserConfigDataSourceList\\": [\\n {\\n \\"Code\\": \\"QuarkCommonNews\\",\\n \\"Name\\": \\"夸克通用搜索\\",\\n \\"Number\\": 20,\\n \\"Type\\": \\"SystemSearch\\",\\n \\"Enable\\": true\\n }\\n ],\\n \\"TotalDocSize\\": 1\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"428DCC0D-3C63-5306-BD1B-124396AB97BE\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取信源配置权重数据',
- ],
- 'GetDocInfo' => [
- 'summary' => '妙读获取文档信息。',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
- ],
- ],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
- [
- 'name' => 'WorkspaceId',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '自定义提示词', 'description' => '自定义的润色要求', 'type' => 'string', 'required' => false, 'example' => '自定义的润色要求'],
],
[
- 'name' => 'DocId',
+ 'name' => 'OriginContent',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['title' => '原始文章', 'description' => '原始文章', 'type' => 'string', 'required' => false, 'example' => '原始文章内容'],
],
[
- 'name' => 'CategoryId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档所在目录',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['title' => '任务ID,(同一个任务ID共享会话)', 'description' => '任务ID,(同一个任务ID共享会话,任务超时时间12个小时)', 'type' => 'string', 'required' => false, 'example' => 'taskld-xxxxx'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'BaseLlmResponse',
+ 'description' => 'BaseLlmResponse',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '内部错误码',
- 'type' => 'string',
- 'example' => 'successful',
+ 'Header' => [
+ 'title' => '响应头',
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
+ ],
],
- 'Data' => [
- 'description' => '返回数据',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'DocName' => [
- 'description' => '文档名称',
- 'type' => 'string',
- 'example' => '電視廣播2020年報',
- ],
- 'DocType' => [
- 'description' => '文档类型',
- 'type' => 'string',
- 'example' => 'pdf',
- ],
- 'FileUrl' => [
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'http://xxx/xxx.pdf',
- ],
- 'Status' => [
- 'description' => '任务状态信息',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1和0,当状态为1时 表示获取文档成功,用户可进行生成文档摘要、生脑图等操作',
- ],
- 'StatusMessage' => [
- 'description' => '状态消息',
- 'type' => 'string',
- 'example' => '导入成功',
- ],
- 'VideoContents' => [
- 'description' => '视频中的语音内容文本数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '视频中的语音内容文本',
- 'type' => 'string',
- 'example' => '文本内容',
+ 'Output' => [
+ 'title' => '输出',
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
],
],
- 'CategoryId' => [
- 'description' => '文档所在目录',
- 'type' => 'string',
- 'example' => 'default',
+ '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'],
+ ],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回结果消息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '润色',
+ 'summary' => '创作-文本润色。',
+ 'changeSet' => [
+ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DocName\\": \\"電視廣播2020年報\\",\\n \\"DocType\\": \\"pdf\\",\\n \\"FileUrl\\": \\"http://xxx/xxx.pdf\\",\\n \\"Status\\": 0,\\n \\"StatusMessage\\": \\"导入成功\\",\\n \\"VideoContents\\": [\\n \\"文本内容\\"\\n ],\\n \\"CategoryId\\": \\"default\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取文档信息',
- ],
- 'GetFileContentLength' => [
- 'summary' => '妙读获得文档字数。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTextPolishing',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n}","type":"json"}]',
+ ],
+ 'RunTitleGeneration' => [
+ 'path' => '/quanmiao/aimiaobi/runTitleGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
+ ],
+ [
+ 'name' => 'ReferenceData',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
+ 'description' => '要生成标题的数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Contents' => [
+ 'description' => '正文列表',
+ 'type' => 'array',
+ 'items' => ['description' => '正文', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
+ 'required' => true,
+ ],
+ ],
'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
],
],
[
- 'name' => 'DocName',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test.pdf',
- ],
+ 'schema' => ['description' => '关联创作文章唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'FileUrl',
+ 'name' => 'TitleCount',
'in' => 'formData',
+ 'schema' => ['title' => '标题生成个数,最大10个。', 'description' => '标题生成个数,最大10个。', 'type' => 'string', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'DeduplicatedTitles',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '文件地址',
- 'type' => 'string',
+ 'title' => '新生成的标题 需要与之去重的标题集合。所有标题字数最多5K个字',
+ 'description' => '新生成的标题 需要与之去重的标题集合。所有标题字数最多5K个字',
+ 'type' => 'array',
+ 'items' => ['description' => '待去重的标题', 'type' => 'string', 'required' => false, 'example' => '标题xxxx'],
'required' => false,
- 'example' => 'https://xxx/test.pdf',
],
],
],
@@ -41275,279 +23553,260 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'AccessForbid'],
+ 'ErrorMessage' => ['description' => '错误码消息。', 'type' => 'string', 'example' => 'xxx'],
+ 'Event' => ['description' => 'SSE事件。', 'type' => 'string', 'example' => 'task-failed'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'StatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '50a1cc8e-717e-4a2b-a76b-dc9734a8564b'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0a3d448f17000139741898287e0eb3'],
+ ],
],
- 'Data' => [
- 'description' => '业务数据',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'WordNum' => [
- 'description' => '文件长度',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1024',
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
+ ],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'string', 'example' => '200'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'AccessForbid'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '标题生成',
+ 'summary' => '妙笔:标题生成。',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-31T12:47:21.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"DD656AF9-0839-521A-A3D2-F320009F9C87\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"WordNum\\": 1024\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取文件长度',
- ],
- 'UploadBook' => [
- 'summary' => '妙读上传书籍。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTitleGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"50a1cc8e-717e-4a2b-a76b-dc9734a8564b\\",\\n \\"TraceId\\": \\"0a3d448f17000139741898287e0eb3\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xxx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"94512A33-8EC1-5452-A793-5C91F18ED2F0\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"AccessForbid\\",\\n \\"Message\\": \\"数据不存在\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'RunTopicSelectionMerge' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-ipe7d81yq4sl5jmk',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'Docs',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档',
- 'type' => 'object',
- 'properties' => [
- 'DocName' => [
- 'description' => '文档名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '文档1.pdf',
- ],
- 'FileUrl' => [
- 'description' => '文件 URL',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'http://xxx/ccc.pdf',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '其他写作参数(prompt 和 writingParams 二选一)', 'description' => '自定义融合prompt', 'type' => 'string', 'required' => false, 'example' => '请从xxxx的角度,分析xxxx事件'],
],
[
- 'name' => 'CategoryId',
+ 'name' => 'Topics',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '目录ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
+ 'title' => '选题策划列表',
+ 'description' => '待融合的选题视角列表',
+ 'type' => 'array',
+ 'items' => ['description' => '待融合的选题视角', 'required' => false, '$ref' => '#/components/schemas/TopicSelection'],
+ 'required' => true,
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'BaseLlmResponse',
+ 'description' => 'BaseLlmResponse',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
+ 'Header' => [
+ 'title' => '响应头',
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'StatusCode' => ['title' => 'http响应码', 'description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
+ ],
],
- 'Data' => [
- 'description' => '业务数据',
+ 'Payload' => [
+ 'title' => '响应体',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'DocIds' => [
- 'description' => '文档ID',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'example' => 'aaaxxx',
+ 'Output' => [
+ 'title' => '输出',
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
+ 'Topic' => ['description' => '融合后的选题策划对象', '$ref' => '#/components/schemas/TopicSelection'],
],
],
- 'ExistedIds' => [
- 'description' => '错误文档Id',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档Id',
- 'type' => 'string',
- 'example' => 'ccccc',
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ 'InputTokens' => ['description' => '输入Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '78'],
+ 'OutputTokens' => ['description' => '输出使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
+ 'TokenMap' => [
+ 'description' => 'token消耗明细',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'integer', 'format' => 'int64', 'example' => '44', 'description' => 'token消耗量'],
+ ],
+ 'TotalTokens' => ['description' => '本次调用使用的所有Token数总和', 'type' => 'integer', 'format' => 'int64', 'example' => '38'],
],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'End' => ['description' => '响应包是否结束', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DocIds\\": [\\n \\"aaaxxx\\"\\n ],\\n \\"ExistedIds\\": [\\n \\"ccccc\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '书籍上传',
- ],
- 'UploadDoc' => [
- 'summary' => '妙读上传文档接口。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '选题热点融合',
+ 'summary' => '妙策选题策划聚合',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTopicSelectionMerge',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\",\\n \\"Topic\\": {\\n \\"Point\\": \\"选题视角\\\\n\\\\n\\",\\n \\"Summary\\": \\"摘要\\",\\n \\"Outlines\\": [\\n {\\n \\"Outline\\": \\"大纲\\",\\n \\"Summary\\": \\"摘要\\"\\n }\\n ]\\n }\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 78,\\n \\"OutputTokens\\": 34,\\n \\"TokenMap\\": {\\n \\"key\\": 44\\n },\\n \\"TotalTokens\\": 38\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true\\n}","type":"json"}]',
+ ],
+ 'RunTranslateGeneration' => [
+ 'path' => '/quanmiao/aimiaobi/runTranslateGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-yigtrrjl377rcbab',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'Docs',
+ 'name' => 'ReferenceData',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '文档',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档',
- 'type' => 'object',
- 'properties' => [
- 'DocName' => [
- 'description' => '文档名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '文档1.pdf',
- ],
- 'FileUrl' => [
- 'description' => '文件url',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'http://xxx/ccc.pdf',
- ],
+ 'description' => '生成需要的数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Contents' => [
+ 'description' => '正文列表',
+ 'type' => 'array',
+ 'items' => ['description' => '正文', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
+ 'required' => true,
],
- 'required' => true,
],
'required' => true,
],
],
[
- 'name' => 'CategoryId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档所在目录,如果不填值是default',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['description' => '非必填,关联创作文章唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '支持的翻译的语种(源语言系统会自动识别)'."\n"
+ .'| language | prompt |'."\n"
+ .'|----------|--------|'."\n"
+ .'| 英语 | English |'."\n"
+ .'| 简体中文 | Chinese |'."\n"
+ .'| 日语 | Japanese |'."\n"
+ .'| 韩语 | Korean |'."\n"
+ .'| 西班牙语 | Spanish |'."\n"
+ .'| 法语 | French |'."\n"
+ .'| 葡萄牙语 | Portuguese |'."\n"
+ .'| 德语 | German |'."\n"
+ .'| 意大利语 | Italian |', 'type' => 'string', 'required' => true, 'example' => 'English'],
],
],
'responses' => [
@@ -41557,185 +23816,143 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '内部错误码',
- 'type' => 'string',
- 'example' => 'successful',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'AccessForbid'],
+ 'ErrorMessage' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'xx'],
+ 'Event' => ['description' => 'SSE事件。', 'type' => 'string', 'example' => 'task-failed'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '91C2B2B8-7D12-4A8D-A724-1E576D30C096'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '0abb781d17146157564845243e20b5'],
+ ],
],
- 'Data' => [
- 'description' => '文档信息',
+ 'Payload' => [
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'DocIds' => [
- 'description' => '成功的文档Id数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'example' => 'aaaxxx',
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => '文本生成结果', 'type' => 'string', 'example' => 'xx'],
],
],
- 'ExistedIds' => [
- 'description' => '因为已经存在无法上传的文档Id',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档Id',
- 'type' => 'string',
- 'example' => 'ccccc',
+ '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'],
],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '中英翻译',
+ 'summary' => 'AI妙笔-创作-中英文翻译。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DocIds\\": [\\n \\"aaaxxx\\"\\n ],\\n \\"ExistedIds\\": [\\n \\"ccccc\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '文档上传',
- 'description' => '文档上传是通过异步调用的方式实现,调用之后需要使用getDocInfo接口进行循环检查文档状态,当文档状态为1时,才能进行后续的文档摘要、生成全文脑图、问答内容总结、抽取关键词、改写等操作。',
- ],
- 'ListDocs' => [
- 'summary' => '妙读获取文档列表。',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTranslateGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"91C2B2B8-7D12-4A8D-A724-1E576D30C096\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0abb781d17146157564845243e20b5\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"DA021073-17CE-5CCF-9FEB-93226C766887\\"\\n}","type":"json"}]',
+ ],
+ 'RunVideoScriptGenerate' => [
+ 'summary' => 'AI生成视频剪辑脚本',
+ 'path' => '/miaobi/runVideoScriptGenerate',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'DocName',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '文档名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '企业2022年報',
- ],
- ],
- [
- 'name' => 'DocType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '文档类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'pdf',
- ],
- ],
- [
- 'name' => 'Skip',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '跳过n条记录,用于分页',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '视频脚本的提示词', 'description' => '视频脚本的提示词', 'type' => 'string', 'required' => true, 'example' => '写一篇关于黄山旅游的脚本'],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'UseSearch',
'in' => 'formData',
- 'schema' => [
- 'description' => '返回的最大结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '是否使用联网检索(如果选是,则会意图理解后联网检索相关参考素材)', 'description' => '是否使用联网检索(如果选是,则会意图理解后联网检索相关参考素材)', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'ScriptLength',
'in' => 'formData',
- 'schema' => [
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => '52a33dc83779f63641e16f5146cd7125',
- ],
+ 'schema' => ['title' => '脚本篇幅 描述 可选值有:'."\n"
+ ."\n"
+ .'20~75:10~15s正常口播时长'."\n"
+ .'75~150:15~30s正常口播时长'."\n"
+ .'150~300:≈30~60s正常口播时长'."\n"
+ .'>=300:≥60s正常口播时长', 'description' => '脚本篇幅 描述 可选值有:'."\n"
+ ."\n"
+ .'20~75:10~15s正常口播时长'."\n"
+ ."\n"
+ .'75~150:15~30s正常口播时长'."\n"
+ ."\n"
+ .'150~300:≈30~60s正常口播时长'."\n"
+ ."\n"
+ .'\\>=300:≥60s正常口播时长', 'type' => 'string', 'required' => false, 'example' => '>=300'],
],
[
- 'name' => 'Statuses',
+ 'name' => 'Language',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '文档状态列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '状态值',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '生成脚本的语言:'."\n"
+ .'建议取值有:'."\n"
+ .'zh-CN: 中文,'."\n"
+ .'en-US: 英文.'."\n"
+ .'默认中文', 'description' => '生成脚本的语言:'."\n"
+ .'建议取值有:'."\n"
+ ."\n"
+ .'zh-CN: 中文'."\n"
+ ."\n"
+ .'en-US: 英文'."\n"
+ ."\n"
+ .'默认中文', 'type' => 'string', 'required' => false, 'example' => 'en-US'],
],
[
- 'name' => 'CategoryId',
+ 'name' => 'ScriptNumber',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档所在目录',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
+ 'schema' => ['title' => '生成脚本的篇数。默认1篇,最多同时生成三篇'."\n"
+ .'如果指定多篇。则会并行返回流式多个脚本生成结果。(客户端通过不同sessionId区分)', 'description' => '生成脚本的篇数。默认1篇,最多同时生成三篇'."\n"
+ .'如果指定多篇。则会并行返回流式多个脚本生成结果。(客户端通过不同sessionId区分)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
],
'responses' => [
@@ -41745,162 +23962,124 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '返回结果编码。',
- 'type' => 'string',
- 'example' => 'successful',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '异常错误码', 'type' => 'string', 'example' => 'ScriptNumberExceed'],
+ 'ErrorMessage' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => '脚本篇数超限'],
+ 'Event' => ['description' => 'event名称', 'type' => 'string', 'example' => 'result-generated'."\n"],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'StatusCode' => ['description' => '状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'b057f2fa-2277-477b-babf-cbc062307828'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'],
+ ],
],
- 'Data' => [
- 'description' => '返回数据结果列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '分页数据',
- 'type' => 'object',
- 'properties' => [
- 'CreateTime' => [
- 'description' => '创建时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'DocId' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'example' => '12345',
- ],
- 'DocName' => [
- 'description' => '文档名称',
- 'type' => 'string',
- 'example' => '标题093',
- ],
- 'DocType' => [
- 'description' => '文档类型',
- 'type' => 'string',
- 'example' => 'pdf',
- ],
- 'Status' => [
- 'description' => '状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0',
- ],
- 'StatusMessage' => [
- 'description' => '状态消息',
- 'type' => 'string',
- 'example' => '导入完成',
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['description' => '文本生成结果', 'type' => 'string', 'example' => '大家好,我是[xxx]。今天带大家走进黄山,感受奇松、怪石、云海、温泉的绝美风光。首站迎客松,800年历史,枝干如臂,热情迎接每一位游客。接着登光明顶,360度全景尽收眼底。再探秘西海大峡谷,体验原始自然的震撼。最后,在温泉中放松身心,享受旅途的美好。希望这次旅行能给你留下难忘的记忆。我是[你的名字],感谢观看,我们下次再见!","91522b25a4f440189320c9ede8ae6c85":"大家好,我是[您的名字],今天带大家探索黄山的奇妙之旅。首先,我们将见到黄山的象征——迎客松,感受它800年的历史与欢迎。随后攀登光明顶,迎接壮丽的日出;漫步西海大峡谷,体验险峻之美;最后,在温泉中放松身心。希望这次旅行能让你爱上黄山。谢谢观看!","1c23af4a899e4b908bdcffa7d8d0ddc9":"大家好,欢迎来到黄山!这里以奇松、怪石、云海、温泉四绝闻名。从云谷寺开始,感受古朴氛围;挑战百步云梯,体验攀登乐趣;漫步西海大峡谷,领略壮丽景色;最后在玉屏楼迎接日出,享受心灵的宁静。希望这次旅行给你留下美好回忆!'],
],
- 'CategoryId' => [
- 'description' => '文档所在目录',
- 'type' => 'string',
- 'example' => 'default',
+ ],
+ 'Usage' => [
+ 'description' => 'token用量',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
],
],
],
],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'MaxResults' => [
- 'description' => '最大返回结果数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Message' => [
- 'description' => '返回消息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'NextToken' => [
- 'description' => '下一页Token',
- 'type' => 'string',
- 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4mYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'TotalCount' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '70',
- ],
+ 'RequestId' => ['description' => '请求唯一标识(当Content-Type返回json时 会返回该字段)', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'HttpStatusCode' => ['description' => 'HTTP状态码(当Content-Type返回json时 会返回该字段)', 'type' => 'string', 'example' => '403'],
+ 'Code' => ['description' => '状态码,正常返回200(当Content-Type返回json时 会返回该字段)', 'type' => 'string', 'example' => 'NoPermission'],
+ 'Message' => ['description' => '错误说明(当Content-Type返回json时 会返回该字段)', 'type' => 'string', 'example' => 'You are not authorized to perform this action.'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败(当Content-Type返回json时 会返回该字段)', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": 0,\\n \\"DocId\\": \\"12345\\",\\n \\"DocName\\": \\"标题093\\",\\n \\"DocType\\": \\"pdf\\",\\n \\"Status\\": 0,\\n \\"StatusMessage\\": \\"导入完成\\",\\n \\"CategoryId\\": \\"default\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"MaxResults\\": 10,\\n \\"Message\\": \\"successful\\",\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4mYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"TotalCount\\": 70\\n}","type":"json"}]',
- 'title' => '获取文档列表',
- ],
- 'DeleteDocs' => [
- 'summary' => '妙读删除多个文档。',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => 'AI生成视频剪辑脚本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunVideoScriptGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"ScriptNumberExceed\\",\\n \\"ErrorMessage\\": \\"脚本篇数超限\\",\\n \\"Event\\": \\"result-generated\\\\n\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"b057f2fa-2277-477b-babf-cbc062307828\\",\\n \\"TraceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"大家好,我是[xxx]。今天带大家走进黄山,感受奇松、怪石、云海、温泉的绝美风光。首站迎客松,800年历史,枝干如臂,热情迎接每一位游客。接着登光明顶,360度全景尽收眼底。再探秘西海大峡谷,体验原始自然的震撼。最后,在温泉中放松身心,享受旅途的美好。希望这次旅行能给你留下难忘的记忆。我是[你的名字],感谢观看,我们下次再见!\\\\\\",\\\\\\"91522b25a4f440189320c9ede8ae6c85\\\\\\":\\\\\\"大家好,我是[您的名字],今天带大家探索黄山的奇妙之旅。首先,我们将见到黄山的象征——迎客松,感受它800年的历史与欢迎。随后攀登光明顶,迎接壮丽的日出;漫步西海大峡谷,体验险峻之美;最后,在温泉中放松身心。希望这次旅行能让你爱上黄山。谢谢观看!\\\\\\",\\\\\\"1c23af4a899e4b908bdcffa7d8d0ddc9\\\\\\":\\\\\\"大家好,欢迎来到黄山!这里以奇松、怪石、云海、温泉四绝闻名。从云谷寺开始,感受古朴氛围;挑战百步云梯,体验攀登乐趣;漫步西海大峡谷,领略壮丽景色;最后在玉屏楼迎接日出,享受心灵的宁静。希望这次旅行给你留下美好回忆!\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": \\"403\\",\\n \\"Code\\": \\"NoPermission\\",\\n \\"Message\\": \\"You are not authorized to perform this action.\\",\\n \\"Success\\": false\\n}","type":"json"}]',
+ ],
+ 'RunWriteToneGeneration' => [
+ 'path' => '/quanmiao/aimiaobi/runWriteToneGeneration',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
[
- 'name' => 'DocIds',
+ 'name' => 'ReferenceData',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '文档ID数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ 'description' => '生成需要的数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Contents' => [
+ 'description' => '正文列表',
+ 'type' => 'array',
+ 'items' => ['description' => '正文', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
+ 'required' => true,
+ ],
],
'required' => true,
],
],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '关联创作文章唯一标识'."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'],
+ ],
+ [
+ 'name' => 'Prompt',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文风:比如"抒情", "豪放", "含蓄", "激动", "亲切", "励志"', 'type' => 'string', 'required' => true, 'example' => '励志'],
+ ],
],
'responses' => [
200 => [
@@ -41909,61 +24088,78 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'description' => '内部错误码。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '返回信息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '2C565EDD-E624-5FED-8565-0A9CB0C8CC46',
+ 'Header' => [
+ 'description' => '响应头',
+ 'type' => 'object',
+ 'properties' => [
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'AccessForbid'],
+ 'ErrorMessage' => ['description' => '调用失败时,返回的出错信息。', 'type' => 'string', 'example' => 'xxx'],
+ 'Event' => ['description' => 'SSE事件。', 'type' => 'string', 'example' => 'task-failed'],
+ 'SessionId' => ['description' => '会话ID', 'type' => 'string', 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51'],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51'],
+ 'TraceId' => ['description' => '全链路ID', 'type' => 'string', 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51'],
+ ],
],
- 'Success' => [
- 'description' => '调用是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
+ 'Payload' => [
+ 'description' => '响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Output' => [
+ 'description' => '输出',
+ 'type' => 'object',
+ 'properties' => [
+ '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'],
+ ],
+ ],
+ ],
],
+ 'RequestId' => ['description' => '请求唯一标识', 'type' => 'string', 'example' => 'FB698445-61DA-5361-BF73-1C5F1157E888'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '文风改写',
+ 'summary' => 'AI妙笔-创作-文风改写。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"2C565EDD-E624-5FED-8565-0A9CB0C8CC46\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '批量删除文档',
- ],
- 'RunMultiDocIntroduction' => [
- 'summary' => '针对多篇文章、视频或者URL,生成总分结构的摘要(几篇文章的综合概述、关键要点)。此外支持多种多语言的输入和输出。',
- 'path' => '/miaodu/stream/runMultiDocIntroduction',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunWriteToneGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"AccessForbid\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"SessionId\\": \\"F1953EE6-157C-40DC-BBF1-87C98AC27C51\\",\\n \\"TaskId\\": \\"F1953EE6-157C-40DC-BBF1-87C98AC27C51\\",\\n \\"TraceId\\": \\"F1953EE6-157C-40DC-BBF1-87C98AC27C51\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"xxx\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"FB698445-61DA-5361-BF73-1C5F1157E888\\"\\n}","type":"json"}]',
+ ],
+ 'RunWriting' => [
+ 'path' => '/quanmiao/aimiaobi/runWriting',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -41971,222 +24167,247 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'DocIds',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '多个文档Id数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10022',
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '提示词', 'description' => '提示词', 'type' => 'string', 'required' => true, 'example' => '提示词'],
+ ],
+ [
+ 'name' => 'TaskId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '任务ID,多轮对话可复用同一轮任务ID', 'description' => '任务ID,多轮对话可复用同一轮任务ID'."\n"
+ ."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '75bf82fa-b71b-45d7-ae40-0b00e496cd9e',
- ],
+ 'schema' => ['title' => '单轮对话的ID', 'description' => '单轮对话的ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'SummaryPrompt',
+ 'name' => 'OriginSessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '摘要-自定义Prompt',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请简明扼要',
- ],
+ 'schema' => ['title' => '重新生成时原始对话的ID', 'description' => '重新生成时原始对话的ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'KeyPointPrompt',
+ 'name' => 'WritingConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '重点-自定义Prompt',
- 'type' => 'string',
+ 'title' => '写作配置',
+ 'description' => '写作配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Domain' => ['title' => '写作领域,media:传媒,government:政务,market:营销', 'description' => '写作领域'."\n"
+ ."\n"
+ .'- media:传媒'."\n"
+ ."\n"
+ .'- government:政务'."\n"
+ ."\n"
+ .'- market:营销', 'type' => 'string', 'required' => false, 'example' => 'media'],
+ 'PromptTag' => [
+ 'title' => '提示词小助手',
+ 'description' => '提示词小助手',
+ 'type' => 'object',
+ 'properties' => [
+ 'NecessaryTips' => ['title' => '必要提示', 'description' => '必要提示', 'type' => 'string', 'required' => false, 'example' => '必要提示'],
+ 'Position' => ['title' => '立场', 'description' => '立场', 'type' => 'string', 'required' => false, 'example' => '立场'],
+ 'ReverseWords' => ['title' => '反向词', 'description' => '反向词', 'type' => 'string', 'required' => false, 'example' => '反向词'],
+ 'Theme' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'required' => false, 'example' => '主题'],
+ ],
+ 'required' => false,
+ ],
+ 'Tags' => [
+ 'title' => '写作时的文体、篇幅、输出语言等控制参数',
+ 'description' => '写作时的文体、篇幅、输出语言等控制参数',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '写作时的文体、篇幅、输出语言等控制参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'Keyword' => ['title' => '选项的值', 'description' => '选项的值', 'type' => 'string', 'required' => false, 'example' => '10'],
+ 'Tag' => ['title' => '选项的Tag。例如 gcNumberSizeTag=10', 'description' => '选项的Tag。例如 gcNumberSizeTag=10', 'type' => 'string', 'required' => false, 'example' => 'gcNumberSizeTag'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'UseSearch' => ['title' => '是否自动补充素材', 'description' => '是否自动补充素材', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
'required' => false,
- 'example' => '请简明扼要',
],
],
[
- 'name' => 'ModelName',
+ 'name' => 'ReferenceData',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
+ 'title' => '写作时的参考文章数据',
+ 'description' => '写作时的参考文章数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Articles' => [
+ 'title' => '写作时的参考文章数据',
+ 'description' => '写作时的参考文章数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '写作时的参考文章数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'required' => false, 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'required' => false, 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'required' => false, 'example' => '2124ca4d48a542d788aa86151e1a8c8b'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'required' => false, 'example' => '2024-08-28 11:38:28'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'required' => false, 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'required' => false, 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'required' => false, 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'BaseLlmResponse',
+ 'description' => 'BaseLlmResponse',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
'Header' => [
+ 'title' => '响应头',
'description' => '响应头',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'Message does not exist.',
- ],
- 'Event' => [
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'b057f2fa-2277-477b-babf-cbc062307828',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b',
- ],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'type' => 'string', 'example' => 'task-started'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'StatusCode' => ['title' => 'http响应码', 'description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
],
],
'Payload' => [
+ 'title' => '响应体',
'description' => '响应体',
'type' => 'object',
'properties' => [
'Output' => [
+ 'title' => '输出',
'description' => '输出',
'type' => 'object',
'properties' => [
- 'Summary' => [
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要内容',
- ],
- 'KeyPoints' => [
- 'description' => '关键点信息。',
+ 'Articles' => [
+ 'title' => '参照文章',
+ 'description' => '参照文章',
'type' => 'array',
'items' => [
- 'description' => '关键点信息。',
+ 'description' => '参照文章',
'type' => 'object',
'properties' => [
- 'KeyPoint' => [
- 'description' => '关键点信息',
- 'type' => 'string',
- 'example' => '关键点信息',
- ],
- 'Source' => [
- 'description' => '信息来源',
- 'type' => 'string',
- 'example' => '信息来源',
- ],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => '98229f6001cf4deeb1668191d4eccc75'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-08-28 11:38:28'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
],
],
],
+ 'MiniDoc' => [
+ 'title' => '文章精排之后的片段列表',
+ 'description' => '文章精排之后的片段列表',
+ 'type' => 'array',
+ 'items' => ['title' => '文章精排之后的片段'."\n"
+ .' * ', 'description' => '文章精排之后的片段'."\n"
+ .' * ', 'type' => 'string', 'example' => '文章精排之后的片段'],
+ 'example' => '文章精排之后的片段',
+ ],
+ 'SearchQuery' => ['title' => 'query改写结果', 'description' => 'query改写结果', 'type' => 'string', 'example' => '大模型改变世界'],
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
],
],
'Usage' => [
- 'description' => 'token用量',
+ 'description' => 'token消耗',
'type' => 'object',
'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '165',
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'OutputTokens' => ['description' => '输出使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'TokenMap' => [
+ 'description' => 'token消耗明细',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'integer', 'format' => 'int64', 'example' => '44', 'description' => 'token消耗明细'],
],
+ 'TotalTokens' => ['description' => '本次调用使用的所有Token数总和', 'type' => 'integer', 'format' => 'int64', 'example' => '2'],
],
],
],
],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'End' => ['description' => '此次请求是否结束', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '直接写作',
+ 'summary' => '直接写作',
+ 'description' => '该接口已过时,请参考: [RunWritingV2](~~2922606~~)'."\n"
+ ."\n"
+ .'全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-16T05:44:25.000Z', 'description' => '响应参数发生变更'],
+ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => '错误码发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"200\\",\\n \\"ErrorMessage\\": \\"Message does not exist.\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"92e16ccb-92b6-4894-abbf-fc6e2929a0df\\",\\n \\"TaskId\\": \\"b057f2fa-2277-477b-babf-cbc062307828\\",\\n \\"TraceId\\": \\"46e5c2b5-0877-4f09-bd91-ab0cf314e48b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Summary\\": \\"大纲摘要内容\\",\\n \\"KeyPoints\\": [\\n {\\n \\"KeyPoint\\": \\"关键点信息\\",\\n \\"Source\\": \\"信息来源\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 65,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 165\\n }\\n }\\n}","type":"json"}]',
- 'title' => '多文档聚合摘要',
- ],
- 'RunDocBrainmap' => [
- 'summary' => '针对文章或者书,生成三级脑图,且支持生成多语种,支持控制脑图第二级数量,支持控制叶子节点的字数。',
- 'path' => '/miaodu/stream/runDocBrainmap',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-started\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"98229f6001cf4deeb1668191d4eccc75\\",\\n \\"PubTime\\": \\"2024-08-28 11:38:28\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"MiniDoc\\": [\\n \\"文章精排之后的片段\\"\\n ],\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 1,\\n \\"TokenMap\\": {\\n \\"key\\": 44\\n },\\n \\"TotalTokens\\": 2\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true\\n}","type":"json"}]',
+ ],
+ 'RunWritingV2' => [
+ 'summary' => '智能写作。',
+ 'path' => '/quanmiao/aimiaobi/runWritingV2',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -42194,1043 +24415,932 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '任务ID,多轮对话可复用同一轮任务ID', 'description' => '任务唯一ID,多轮对话可复用同一轮任务ID'."\n"
+ ."\n"
+ .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
+ .'>', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'DocId',
+ 'name' => 'SessionId',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['title' => '单轮对话的ID', 'description' => '单轮对话的ID(已过期,不推荐传递)', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'WritingScene',
'in' => 'formData',
- 'schema' => [
- 'description' => '脑图自定义prompt要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请按英文输出',
- ],
+ 'schema' => ['title' => '写作场景(government:政务、media:传媒、market:营销,office:办公,custom:自定义)', 'description' => '写作场景(government:政务、media:传媒、market:营销,office:办公,custom:自定义)', 'type' => 'string', 'required' => false, 'example' => 'media'],
],
[
- 'name' => 'CleanCache',
+ 'name' => 'WritingStyle',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否清理掉之前的缓存',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '写作文体', 'description' => '写作文体,具体文体列表请参考:[ListWritingStyles](~~2922609~~)', 'type' => 'string', 'required' => false, 'example' => '新闻评论'],
],
[
- 'name' => 'NodeNumber',
+ 'name' => 'DistributeWriting',
'in' => 'formData',
- 'schema' => [
- 'description' => '第二级有几个节点',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['title' => '是否为分步骤写作', 'description' => '是否为分步骤写作,请参考 接口请求示例 的 分步骤 参数说明。', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'WordNumber',
+ 'name' => 'PromptMode',
'in' => 'formData',
- 'schema' => [
- 'description' => '节点文字的个数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '模板类型(Template:模板模式, PE:高级PE模式)', 'description' => '模板类型:Template(模板模式), PE(高级PE模式)'."\n"
+ ."\n"
+ .'1. 当 PromptMode为空时,传Prompt,推荐格式为:写作主题+写作篇幅+写作要求+禁止事项'."\n"
+ ."\n"
+ .'2. 当 PromptMode=Template时,需要传 WritingParams(字典类型,key、value都是字符串),writingParams 表单定义参考:[ListWritingStyles](~~2922609~~)接口中的 .Data.TemplateDefine[].Fields'."\n"
+ ."\n"
+ .'3. 当 PromptMode=PE,需要传WritingParams,且固定传两个字段'."\n"
+ .' 1. topic: 话题,必填。需要写的主题内容'."\n"
+ .' 2. prompt: 其他自定义提示词,选填。其他写作要求', 'type' => 'string', 'required' => false, 'example' => 'Template'],
],
[
- 'name' => 'referenceContent',
+ 'name' => 'Step',
'in' => 'formData',
- 'schema' => [
- 'description' => '要生成脑图的内容,优先级高于docId',
- 'type' => 'string',
- 'required' => false,
- 'example' => '要生成脑图的内容',
- ],
+ 'schema' => ['title' => '分步骤写作步骤:'."\n"
+ .'OutlineGenerate:大纲生成'."\n"
+ .'OutlineSearch:写完大纲之后,根据大纲内容检索'."\n"
+ .'Writing:写作', 'description' => '分步骤写作步骤:'."\n"
+ .'- OutlineGenerate: 大纲生成'."\n"
+ .'- Writing: 写作'."\n"
+ ."\n"
+ .'在分步骤写作场景中(DistributeWriting=true) 默认 先写大纲、后根据大纲写作。', 'type' => 'string', 'required' => false, 'example' => 'Writing'],
],
[
- 'name' => 'ModelName',
+ 'name' => 'Articles',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
- ],
- ],
- ],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
- 'type' => 'object',
- 'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '07181f55-2311-48af-8048-132a77dee020',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '161816',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '6427cdf4-2ffe-4d05-b0ef-c4adceea90f4',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '脑图json内容',
- 'type' => 'string',
- 'example' => '{"xxxx":"xxx"}',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '65',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '165',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
+ 'title' => '引用的文章',
+ 'description' => '引用的文章(注意 传递此参数后, 联网检索将不会进行,影响:SearchSources、 SearchSources 参数)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '文章对象',
+ 'description' => '文章对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['title' => '文章标题', 'description' => '文章标题', 'type' => 'string', 'required' => false, 'example' => '文章标题'],
+ 'Content' => ['title' => '文章内容', 'description' => '文章内容', 'type' => 'string', 'required' => false, 'example' => '文章内容'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'],
+ 'Source' => ['title' => '文章来源', 'description' => '文章来源', 'type' => 'string', 'required' => false, 'example' => '新华社'],
+ 'SearchSourceName' => ['title' => '搜索信源', 'description' => '搜索信源', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'required' => false, 'example' => '2024-11-25 14:25:59'],
],
+ 'required' => false,
],
+ 'required' => false,
],
],
- ],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"07181f55-2311-48af-8048-132a77dee020\\",\\n \\"TaskId\\": \\"161816\\",\\n \\"TraceId\\": \\"6427cdf4-2ffe-4d05-b0ef-c4adceea90f4\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"{\\\\\\"xxxx\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 65,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 165\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n}","type":"json"}]',
- 'title' => '全文脑图',
- ],
- 'RunDocIntroduction' => [
- 'summary' => '针对一篇文章、视频或者URL,生成文章的导读内容,包含全文总结、关键要点、章节速览(即分段、每段的总结、段落摘要)。此外支持多种多语言的输入和输出。如果用户仅需要对文章进行全文总结,可使用RunDocSummary接口实现,具体请参见https://help.aliyun.com/zh/model-studio/api-aimiaobi-2023-08-01-rundocsummary。',
- 'path' => '/miaodu/stream/runDocIntroduction',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'GcNumberSizeTag',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文章篇幅(短篇、中篇、长篇。或者 2K字、3K字、4K字等等长度描述)', 'description' => '文章篇幅描述(300字左右、600字左右、1000字左右、2000字左右等)', 'type' => 'string', 'required' => false, 'example' => '2000字左右'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREsfmJIZ0TW',
+ [
+ 'name' => 'GcNumberSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '写作的篇数(多篇按照不同的sessionId同时返回)', 'description' => '写作的篇数(多篇按照不同的sessionId同时返回)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'],
],
- ],
- 'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'Language',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['title' => '文章输出语言(en:英文,zh:中文)', 'description' => '文章输出语言'."\n"
+ ."\n"
+ .'- en:英文'."\n"
+ .'- zh:中文'."\n"
+ .'- 或者其他自定义的输出语言要求', 'type' => 'string', 'required' => false, 'example' => 'en'],
],
[
- 'name' => 'DocId',
+ 'name' => 'Keywords',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
+ 'title' => '关键词列表(会参与到检索与写作)',
+ 'description' => '关键词列表(会参与到检索与写作)',
+ 'type' => 'array',
+ 'items' => ['title' => '关键词(会参与到检索与写作)', 'description' => '关键词(会参与到检索与写作)', 'type' => 'string', 'required' => false, 'example' => '关键词'],
+ 'required' => false,
],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a3b5eb35-6b28-4cf9-ac09-1dec25ab4df6',
- ],
+ 'schema' => ['title' => '其他写作参数(prompt 和 writingParams 二选一)', 'description' => '写作提示词(prompt 和 writingParams 二选一,详情请参考PromptMode字段说明)', 'type' => 'string', 'required' => false, 'example' => '提示词'],
],
[
- 'name' => 'SummaryPrompt',
+ 'name' => 'WritingParams',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '总结内容自定义要求',
- 'type' => 'string',
+ 'title' => '写作提示词(prompt 和 writingParams 二选一)',
+ 'description' => '模板写作参数(字典结构,key value 都是字符串)(prompt 和 writingParams 二选一,详情请参考PromptMode字段说明)',
+ 'type' => 'object',
'required' => false,
- 'example' => '用英文输出',
+ 'additionalProperties' => ['type' => 'string', 'example' => '模板写作参数', 'description' => '模板写作参数'],
],
],
[
- 'name' => 'KeyPointPrompt',
+ 'name' => 'Outlines',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '关键点自定义要求',
- 'type' => 'string',
+ 'title' => '大纲列表(分步骤接口使用)',
+ 'description' => '大纲列表(分步骤接口使用,已过时,推荐使用新版分步骤写作的:OutlineList)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '大纲对象',
+ 'description' => '大纲对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Outline' => ['title' => '大纲', 'description' => '大纲', 'type' => 'string', 'required' => false, 'example' => '大纲'],
+ 'Articles' => [
+ 'title' => '大纲重点参考的文章列表',
+ 'description' => '大纲重点参考的文章列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '大纲重点参考的文章',
+ 'description' => '大纲重点参考的文章',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '标题'],
+ 'Content' => ['title' => '正文内容', 'description' => '正文内容', 'type' => 'string', 'required' => false, 'example' => '正文内容'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => '文章URL'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '用英文输出',
],
],
[
- 'name' => 'IntroductionPrompt',
+ 'name' => 'Summarization',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '导读内容自定义要求',
- 'type' => 'string',
+ 'title' => '摘编对象列表(分步骤接口使用)',
+ 'description' => '摘编对象列表(分步骤接口使用)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '摘编对象',
+ 'description' => '摘编对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Event' => ['title' => '事件名称', 'description' => '事件名称', 'type' => 'string', 'required' => false, 'example' => '事件名称'."\n"
+ ."\n"],
+ 'Message' => ['title' => '事件摘编', 'description' => '事件摘编', 'type' => 'string', 'required' => false, 'example' => '事件摘编'."\n"
+ ."\n"],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '用英文输出',
],
],
[
- 'name' => 'CleanCache',
+ 'name' => 'MiniDocs',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '清除缓存',
- 'type' => 'boolean',
+ 'title' => '文章片段列表',
+ 'description' => '文章片段列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '文章片段对象',
+ 'description' => '文章片段对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '片段内容', 'description' => '片段内容', 'type' => 'string', 'required' => false, 'example' => '片段内容'."\n"
+ ."\n"],
+ 'Star' => ['title' => '是否重点考虑该片段', 'description' => '是否重点考虑该片段', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Index' => ['title' => '文章片段在引用文章中的索引', 'description' => '文章片段在引用文章中的索引', 'type' => 'string', 'required' => false, 'example' => '索引'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'true',
],
],
[
- 'name' => 'referenceContent',
+ 'name' => 'UseSearch',
'in' => 'formData',
+ 'schema' => ['title' => '是否使用搜索', 'description' => '是否使用联网检索。(默认不检索,true 则会 走 系统自带的 联网检索)', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'SearchSources',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '要进行导读的内容,如果不为空,该值优先于docId',
- 'type' => 'string',
+ 'title' => '使用指定的搜索源列表',
+ 'description' => '使用指定的搜索源列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '搜索源对象',
+ 'description' => '搜索源对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索', 'description' => 'SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方API搜索', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch'],
+ 'Name' => ['title' => '搜索源描述', 'description' => '搜索源描述(已过时,不推荐使用, 传递后不会生效)', 'type' => 'string', 'required' => false, 'example' => '互联网搜索'],
+ 'DatasetName' => ['title' => '数据源唯一标识', 'description' => '数据源唯一标识', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => '要进行导读的内容',
],
],
[
- 'name' => 'ModelName',
+ 'name' => 'OutlineList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
+ 'title' => '大纲列表(新版分大纲写作)',
+ 'description' => '大纲列表(新版分大纲写作)',
+ 'type' => 'array',
+ 'items' => ['description' => '大纲', 'required' => false, '$ref' => '#/components/schemas/WritingOutline'],
'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
],
],
+ [
+ 'name' => 'SourceTraceMethod',
+ 'in' => 'formData',
+ 'schema' => ['title' => '溯源方式(目前仅支持modelSourceTrace)'."\n"
+ .' modelSourceTrace:在最后输出的正文中,让模型在 各个片段的尾部输出引用标记。以 [[n]]。索引从1开始。', 'description' => '溯源方式(目前仅支持modelSourceTrace)'."\n"
+ .' modelSourceTrace:在最后输出的正文中,让模型在 各个片段的尾部输出引用标记。以 [[n]]。索引从1开始。', 'type' => 'string', 'required' => false, 'example' => 'modelSourceTrace'],
+ ],
],
'responses' => [
200 => [
+ 'description' => '成功',
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'BaseLlmResponse',
+ 'description' => 'BaseLlmResponse',
'type' => 'object',
'properties' => [
'Header' => [
+ 'title' => '响应头',
'description' => '响应头',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '20247a52-23e2-46fb-943d-309cdee2bc6d',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '8a9cecb7-6d20-32db-8823-5882c217b647',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0bd58ea2-dc38-45da-ac02-17f05cb9040b',
- ],
+ 'ErrorCode' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => '错误码'],
+ 'ErrorMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '错误信息'],
+ 'Event' => ['title' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败', 'description' => '分为两类事件,写作事件以及其他事件'."\n"
+ ."\n"
+ .'写作事件:task-progress-start-generating,每次输出都是全量的文章信息'."\n"
+ ."\n"
+ .'其他事件(可以不用关注,或者关注 payload.output.text即可):'."\n"
+ .' writing-instruction-analysis:指令分析'."\n"
+ .' task-progress-news-search-end:联网检索'."\n"
+ .' result-intent-recognition-end:意图识别', 'type' => 'string', 'example' => 'task-progress-start-generating'],
+ 'OriginSessionId' => ['title' => '父会话ID', 'description' => '父会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'SessionId' => ['title' => '会话ID', 'description' => '会话ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'StatusCode' => ['title' => 'http响应码', 'description' => 'http响应码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TraceId' => ['title' => '全链路ID', 'description' => '全链路ID', 'type' => 'string', 'example' => '全链路ID'],
],
],
'Payload' => [
+ 'title' => '响应体',
'description' => '响应体',
'type' => 'object',
'properties' => [
'Output' => [
+ 'title' => '输出',
'description' => '输出',
'type' => 'object',
'properties' => [
- 'Introductions' => [
- 'description' => '分段导读内容数组',
+ 'Articles' => [
+ 'title' => '参照文章',
+ 'description' => '参照文章',
'type' => 'array',
'items' => [
+ 'description' => '参照文章',
'type' => 'object',
'properties' => [
- 'Blocks' => [
- 'description' => '位置信息数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '位置信息',
- 'type' => 'object',
- 'properties' => [
- 'Height' => [
- 'description' => '文本块高',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '600',
- ],
- 'PageId' => [
- 'description' => '文本块所在页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Width' => [
- 'description' => '文本块宽',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '600',
- ],
- 'X' => [
- 'description' => '块左上角X坐标',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Y' => [
- 'description' => '块左上角Y坐标',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'BeginTime' => [
- 'description' => '段落开始时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '0',
- ],
- 'EndTime' => [
- 'description' => '段落结束时间',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1200',
- ],
- ],
- ],
- ],
- 'StartPageId' => [
- 'description' => '多个文本块的起始页号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Summary' => [
- 'description' => '本段摘要',
- 'type' => 'string',
- 'example' => '本段摘要内容',
- ],
- 'Title' => [
- 'description' => '本段标题',
- 'type' => 'string',
- 'example' => '本段标题内容',
- ],
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'DocId' => ['title' => '文档-自定义的唯一ID', 'description' => '文档-自定义的唯一ID', 'type' => 'string', 'example' => '文档-自定义的唯一ID'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识', 'type' => 'string', 'example' => '98229f6001cf4deeb1668191d4eccc75'],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-08-28 11:38:28'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签', 'type' => 'string', 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
],
],
],
- 'KeyPoint' => [
- 'description' => '要点内容',
- 'type' => 'string',
- 'example' => '要点1;要点2;',
+ 'MiniDoc' => [
+ 'title' => '文章精排之后的片段列表',
+ 'description' => '文章精排之后的片段列表',
+ 'type' => 'array',
+ 'items' => ['title' => '文章精排之后的片段'."\n"
+ .' * ', 'description' => '文章精排之后的片段'."\n"
+ .' * ', 'type' => 'string', 'example' => '文章精排之后的片段'],
+ 'example' => '文章精排之后的片段',
],
- 'Summary' => [
- 'description' => '大纲摘要',
- 'type' => 'string',
- 'example' => '大纲摘要内容',
+ 'SearchQuery' => ['title' => 'query改写结果', 'description' => 'query改写结果', 'type' => 'string', 'example' => '大模型改变世界'],
+ 'Text' => ['title' => '文本生成结果', 'description' => '文本生成结果', 'type' => 'string', 'example' => '文本生成结果'],
+ 'Outlines' => [
+ 'title' => '大纲列表(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)',
+ 'description' => '大纲列表(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)',
+ 'type' => 'array',
+ 'items' => ['title' => '', 'description' => '大纲', '$ref' => '#/components/schemas/WritingOutline'],
],
+ 'Title' => ['title' => '文章标题(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)', 'description' => '文章标题(分步骤大纲生成场景下writingStyle=outlineWriting。step=outlineWriting时返回该字段)', 'type' => 'string', 'example' => '文章标题'],
+ 'SearchResult' => ['title' => '检索结果(分步骤大纲生成场景下writingStyle=outlineWriting。step=OutlineSearch 时返回该字段)', 'description' => '检索结果(分步骤大纲生成场景下writingStyle=outlineWriting。step=OutlineSearch 时返回该字段)', '$ref' => '#/components/schemas/OutlineSearchResult'],
+ 'GenerateTraceability' => ['title' => '溯源对象(当传入 该 modelSourceTrace参数 后会返回该字段)', 'description' => '溯源对象(当传入 该 modelSourceTrace参数 后会返回该字段)', '$ref' => '#/components/schemas/GenerateTraceability'],
],
],
'Usage' => [
'description' => 'token用量',
'type' => 'object',
'properties' => [
- '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',
+ 'InputTokens' => ['description' => '输入使用的Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '78'],
+ 'OutputTokens' => ['description' => '输出Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '34'],
+ 'TokenMap' => [
+ 'description' => 'token消耗明细',
+ 'type' => 'object',
+ 'additionalProperties' => ['type' => 'integer', 'format' => 'int64', 'example' => '44', 'description' => 'token消耗明细'],
],
+ 'TotalTokens' => ['description' => '总Token数量', 'type' => 'integer', 'format' => 'int64', 'example' => '38'],
],
],
],
],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => 'C9B5BEA6-E8C4-5861-BE37-D906D516510E',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'End' => ['description' => '响应包是否结束', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '智能写作',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'requestParamsDescription' => '## 接口请求示例'."\n"
+ ."\n"
+ .'### 1. 直接写作(使用 Prompt)'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' //业务空间ID'."\n"
+ .' "WorkspaceId": "your-workspace-id",'."\n"
+ .' //启用检索'."\n"
+ .' "UseSearch":true,'."\n"
+ .' //写作提示词'."\n"
+ .' "Prompt": "请写一篇关于人工智能发展的新闻评论,字数要求800-1000字,要求观点鲜明,逻辑清晰,禁止使用过于夸张的表述。"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'### 2. 模板写作(PromptMode=Template)'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "WorkspaceId": "your-workspace-id",'."\n"
+ .' "WritingScene": "media",'."\n"
+ .' "WritingStyle": "新闻评论",'."\n"
+ .' "PromptMode": "Template",'."\n"
+ .' "WritingParams": {'."\n"
+ .' "topic": "人工智能在医疗领域的应用突破,某医院成功使用AI辅助诊断系统,准确率达到95%以上",'."\n"
+ .' "corePerspective": "AI医疗技术的快速发展体现了科技创新对传统行业的深刻变革,但同时也需要建立完善的法律法规和伦理规范,确保技术应用的安全性和公平性"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**模板字段说明(传媒场景):**'."\n"
+ .'- **topic** (必填): 选题,用简单的语言描述新闻事件或者从常见的新闻中挖掘新颖切入点,1-2000字符'."\n"
+ .'- **corePerspective** (必填): 核心观点,明确价值判断立场、体现社会意义或行业影响,1-2000字符'."\n"
+ ."\n"
+ .'### 3. 高级模式(PromptMode=PE)'."\n"
+ .'>(自定义提示词,系统会完全根据提示词进行写作,区分写作主题与写作要求)'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "WorkspaceId": "your-workspace-id",'."\n"
+ .' "PromptMode": "PE",'."\n"
+ .' "WritingParams": {'."\n"
+ .' "topic": "人工智能发展趋势",'."\n"
+ .' "prompt": "字数要求:800-1000字。写作风格:观点鲜明,逻辑清晰,语言生动。内容要求:需要包含背景介绍、现状分析、未来展望,重点突出创新点。禁止事项:禁止使用过于夸张的表述,避免使用过于专业的术语。其他要求:需要引用具体数据,要求结构层次分明。"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**模板字段说明(PE模式):**'."\n"
+ .'- **topic** (必填): 话题,需要写的主题内容'."\n"
+ .'- **prompt** (可选): 其他自定义提示词,其他写作要求。填写时可按以下格式组织内容:'."\n"
+ .' - **字数要求**:如"字数800-1000字"、"篇幅控制在1500字左右"'."\n"
+ .' - **写作风格**:如"观点鲜明,逻辑清晰"、"语言生动,富有感染力"'."\n"
+ .' - **内容要求**:如"需要包含背景介绍、现状分析、未来展望"、"重点突出创新点"'."\n"
+ .' - **禁止事项**:如"禁止使用过于夸张的表述"、"避免使用专业术语"'."\n"
+ .' - **其他特殊要求**:如"需要引用具体数据"、"要求结构层次分明"'."\n"
+ .' '."\n"
+ .' 多个要求可以用句号、分号或换行分隔,建议格式:`"字数要求:XXX。写作风格:XXX。内容要求:XXX。禁止事项:XXX。其他要求:XXX。"`'."\n"
+ ."\n"
+ .'### 4. 分步骤写作 - 第一步:生成大纲'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "WorkspaceId": "your-workspace-id",'."\n"
+ .' "WritingStyle": "outlineWriting",'."\n"
+ .' "WritingScene": "others",'."\n"
+ .' "Step": "OutlineGenerate",'."\n"
+ .' "Prompt": "请生成一篇关于人工智能发展的新闻评论大纲,字数要求800-1000字,要求包含背景介绍、现状分析、未来展望三个部分"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**说明:**'."\n"
+ .'- 第一步生成大纲,返回结果中包含 `Outlines` 字段,包含生成的大纲结构'."\n"
+ .'- `Prompt` 中应明确说明要生成的大纲主题、字数要求、结构要求等'."\n"
+ .'- 返回的 `Outlines` 结构需要保存,用于第二步传递'."\n"
+ ."\n"
+ .'### 5. 分步骤写作 - 第二步:使用大纲写作'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "WorkspaceId": "your-workspace-id",'."\n"
+ .' "WritingStyle": "outlineWriting",'."\n"
+ .' "WritingScene": "others",'."\n"
+ .' "Step": "Writing",'."\n"
+ .' "OutlineList": ['."\n"
+ .' {'."\n"
+ .' "OutlineId": "outline-001",'."\n"
+ .' "Outline": "人工智能发展背景",'."\n"
+ .' "WordCount": "200-300字",'."\n"
+ .' "Children": ['."\n"
+ .' {'."\n"
+ .' "OutlineId": "outline-001-001",'."\n"
+ .' "Outline": "人工智能技术起源",'."\n"
+ .' "WordCount": "100-150字",'."\n"
+ .' "Children": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "OutlineId": "outline-001-002",'."\n"
+ .' "Outline": "当前发展现状",'."\n"
+ .' "WordCount": "100-150字",'."\n"
+ .' "Children": []'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "OutlineId": "outline-002",'."\n"
+ .' "Outline": "人工智能应用分析",'."\n"
+ .' "WordCount": "300-400字",'."\n"
+ .' "Children": []'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "OutlineId": "outline-003",'."\n"
+ .' "Outline": "未来发展趋势",'."\n"
+ .' "WordCount": "300-400字",'."\n"
+ .' "Children": []'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "Prompt": "根据生成的大纲进行写作,字数要求800-1000字,要求观点鲜明,逻辑清晰,语言生动"'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**说明:**'."\n"
+ .'- 第二步使用大纲进行写作,必须传入第一步返回的 `Outlines` 结构'."\n"
+ .'- `OutlineList` 是必填参数,包含大纲的层级结构,每个大纲节点包含:'."\n"
+ .' - **OutlineId** (必填): 大纲节点ID'."\n"
+ .' - **Outline** (必填): 大纲名称'."\n"
+ .' - **WordCount** (可选): 该部分的字数要求'."\n"
+ .' - **Children** (可选): 子大纲列表,结构同父级大纲'."\n"
+ .'- `Prompt` 中可以补充写作要求,如字数、风格、内容要求等'."\n"
+ ."\n\n"
+ .'### 6. 以稿写稿(快速以稿写稿 - imitateWriting)'."\n"
+ ."\n"
+ .'```json'."\n"
+ .'{'."\n"
+ .' "WorkspaceId": "your-workspace-id",'."\n"
+ .' "WritingScene": "custom",'."\n"
+ .' "WritingStyle": "imitateWriting",'."\n"
+ .' "PromptMode": "Template",'."\n"
+ .' "WritingParams": {'."\n"
+ .' "topic": "新能源汽车市场快速发展,2024年销量突破800万辆,同比增长35%。政策支持、技术进步和消费者接受度提升是主要推动因素。",'."\n"
+ .' "styleStructReferenceContent": "[{\\"title\\":\\"人工智能产业迎来爆发式增长\\",\\"content\\":\\"【引言】\\\\n人工智能技术正在深刻改变着我们的生产和生活方式。从智能语音助手到自动驾驶汽车,从医疗诊断到金融风控,AI应用场景不断拓展。\\\\n\\\\n【发展现状】\\\\n据统计,2023年全球人工智能市场规模达到1500亿美元,预计到2025年将突破3000亿美元。中国作为全球第二大AI市场,在算法、算力、数据等方面都取得了显著进展。\\\\n\\\\n【核心驱动因素】\\\\n一是政策支持力度加大。国家出台多项政策支持AI产业发展,设立专项资金,建设创新平台。\\\\n二是技术突破不断涌现。大模型、深度学习等技术日趋成熟,应用门槛逐步降低。\\\\n三是市场需求持续增长。企业数字化转型加速,对AI解决方案的需求日益旺盛。\\\\n\\\\n【挑战与展望】\\\\n尽管发展迅速,但AI产业仍面临数据安全、算法公平性、人才短缺等挑战。未来需要在技术创新、标准制定、人才培养等方面持续发力,推动AI产业健康可持续发展。\\"}]"'."\n"
+ .' }'."\n"
+ .'}'."\n"
+ .'```'."\n"
+ ."\n"
+ .'**模板字段说明(快速以稿写稿):**'."\n"
+ .'- **topic** (必填): 主题内容,描述要写作的主题和核心信息,最大3000字符'."\n"
+ .'- **styleStructReferenceContent** (必填): 参考结构的文章列表,需要传入 JSON 数组序列化后的字符串,每个元素包含 `title` 和 `content` 字段,用于学习文章的结构和写作风格'."\n"
+ ."\n"
+ .'**其他说明:**'."\n"
+ ."\n"
+ .'- 参考文章应选择结构清晰、层次分明的文章(如:引言-现状-分析-结论的结构)'."\n"
+ .'- 系统会学习参考文章的结构框架和写作风格,然后基于新的主题内容生成新文章'."\n"
+ .'- 建议只选择一篇结构鲜明的参考文章,以确保生成文章的结构一致性',
+ 'changeSet' => [
+ ['createdAt' => '2025-10-11T01:59:31.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"20247a52-23e2-46fb-943d-309cdee2bc6d\\",\\n \\"TaskId\\": \\"8a9cecb7-6d20-32db-8823-5882c217b647\\",\\n \\"TraceId\\": \\"0bd58ea2-dc38-45da-ac02-17f05cb9040b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Introductions\\": [\\n {\\n \\"Blocks\\": [\\n {\\n \\"Height\\": 600,\\n \\"PageId\\": 10,\\n \\"Width\\": 600,\\n \\"X\\": 10,\\n \\"Y\\": 10,\\n \\"BeginTime\\": 0,\\n \\"EndTime\\": 1200\\n }\\n ],\\n \\"StartPageId\\": 10,\\n \\"Summary\\": \\"本段摘要内容\\",\\n \\"Title\\": \\"本段标题内容\\"\\n }\\n ],\\n \\"KeyPoint\\": \\"要点1;要点2;\\",\\n \\"Summary\\": \\"大纲摘要内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"C9B5BEA6-E8C4-5861-BE37-D906D516510E\\"\\n}","type":"json"}]',
- 'title' => '文档导读',
- ],
- 'RunDocSummary' => [
- 'summary' => '针对一篇文章、视频或者URL,生成文章的摘要内容,即全文总结。此外支持多种多语言的输入和输出。',
- 'path' => '/miaodu/stream/runDocSummary',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunWritingV2',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"错误码\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"Event\\": \\"task-progress-start-generating\\",\\n \\"OriginSessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"全链路ID\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Articles\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocId\\": \\"文档-自定义的唯一ID\\",\\n \\"DocUuid\\": \\"98229f6001cf4deeb1668191d4eccc75\\",\\n \\"PubTime\\": \\"2024-08-28 11:38:28\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n }\\n ],\\n \\"MiniDoc\\": [\\n \\"文章精排之后的片段\\"\\n ],\\n \\"SearchQuery\\": \\"大模型改变世界\\",\\n \\"Text\\": \\"文本生成结果\\",\\n \\"Outlines\\": [\\n {\\n \\"WritingTips\\": \\"大纲写作要求、写作提示\\",\\n \\"OutlineId\\": \\"xxx\\",\\n \\"Outline\\": \\"大纲名称\\",\\n \\"SearchKeyWordList\\": [\\n \\"检索关键词\\"\\n ],\\n \\"WordCount\\": \\"写作字数要求的描述\\",\\n \\"Articles\\": [\\n {\\n \\"Url\\": \\"http://www.example.com/xxxx.html\\",\\n \\"Title\\": \\"新闻标题\\",\\n \\"Content\\": \\"新闻内容\\",\\n \\"SearchSource\\": \\"检索源编码\\",\\n \\"SearchSourceName\\": \\"检索源名称\\",\\n \\"PubTime\\": \\"2023-04-11 06:14:07\\",\\n \\"PrimaryOutline\\": \\"一级大纲名称\\",\\n \\"Outline\\": \\"大纲名称\\"\\n }\\n ],\\n \\"Children\\": [\\n {\\n \\"WritingTips\\": \\"大纲写作要求、写作提示\\",\\n \\"OutlineId\\": \\"xxx\\",\\n \\"Outline\\": \\"大纲名称\\",\\n \\"SearchKeyWordList\\": [\\n \\"检索关键词\\"\\n ],\\n \\"WordCount\\": \\"写作字数要求的描述\\",\\n \\"Articles\\": [\\n {\\n \\"Url\\": \\"http://www.example.com/xxxx.html\\",\\n \\"Title\\": \\"新闻标题\\",\\n \\"Content\\": \\"新闻内容\\",\\n \\"SearchSource\\": \\"检索源编码\\",\\n \\"SearchSourceName\\": \\"检索源名称\\",\\n \\"PubTime\\": \\"2023-04-11 06:14:07\\",\\n \\"PrimaryOutline\\": \\"一级大纲名称\\",\\n \\"Outline\\": \\"大纲名称\\"\\n }\\n ],\\n \\"Children\\": [\\n {\\n \\"WritingTips\\": \\"大纲写作要求、写作提示\\",\\n \\"OutlineId\\": \\"xxx\\",\\n \\"Outline\\": \\"大纲名称\\",\\n \\"SearchKeyWordList\\": [\\n \\"检索关键词\\"\\n ],\\n \\"WordCount\\": \\"写作字数要求的描述\\",\\n \\"Articles\\": [\\n {\\n \\"Url\\": \\"http://www.example.com/xxxx.html\\",\\n \\"Title\\": \\"新闻标题\\",\\n \\"Content\\": \\"新闻内容\\",\\n \\"SearchSource\\": \\"检索源编码\\",\\n \\"SearchSourceName\\": \\"检索源名称\\",\\n \\"PubTime\\": \\"2023-04-11 06:14:07\\",\\n \\"PrimaryOutline\\": \\"一级大纲名称\\",\\n \\"Outline\\": \\"大纲名称\\"\\n }\\n ],\\n \\"Children\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Title\\": \\"文章标题\\",\\n \\"SearchResult\\": {\\n \\"Query\\": \\"高校环保义卖案例 大学生旧物循环利用率的文章\\",\\n \\"Outline\\": \\"晨光中的自律:清晨6:30的校园\\",\\n \\"OutlineId\\": \\"xxxxxx\\",\\n \\"PrimaryOutline\\": \\"大学生正能量的一天\\",\\n \\"Articles\\": []\\n },\\n \\"GenerateTraceability\\": {\\n \\"News\\": [\\n {\\n \\"Url\\": \\"http://www.example.com/xxx.html\\\\n\\",\\n \\"Title\\": \\"新闻标题\\",\\n \\"PubTime\\": \\"2024-01-22 10:29:00\\",\\n \\"SearchSourceName\\": \\"检索源编码\\\\n\\\\n\\",\\n \\"SearchSource\\": \\"检索源唯一标识\\",\\n \\"Index\\": 2\\n }\\n ]\\n }\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 78,\\n \\"OutputTokens\\": 34,\\n \\"TokenMap\\": {\\n \\"key\\": 44\\n },\\n \\"TotalTokens\\": 38\\n }\\n },\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true\\n}","type":"json"}]',
+ ],
+ 'SaveCustomText' => [
+ 'summary' => '保存自定义文本。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '标题'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0f56f98a-f2d8-47ec-98e9-1cbdcffa9539',
- ],
+ 'schema' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '内容'],
],
[
- 'name' => 'DocId',
+ 'name' => 'CommodityCode',
'in' => 'formData',
+ 'schema' => ['title' => '商品code', 'description' => '商品code', 'type' => 'string', 'required' => false, 'example' => '商品code'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ ],
],
],
+ ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '保存自定义文本',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '自定义要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请总结一下这篇文档',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": 5,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SaveDataSourceOrderConfig' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'RecommendContent',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
+ ],
+ [
+ 'name' => 'ProductCode',
'in' => 'formData',
'schema' => [
- 'description' => '要总结的内容',
+ 'title' => '产品类型 可选值 miaobi, miaosou',
+ 'description' => '产品类型,可选值如下:'."\n"
+ ."\n"
+ .'- miaobi'."\n"
+ ."\n"
+ .'- miaosou',
'type' => 'string',
- 'required' => false,
- 'example' => '要总结的内容',
+ 'required' => true,
+ 'example' => 'miaobi',
+ 'enum' => ['miaobi', 'miaosou'],
],
],
[
- 'name' => 'CleanCache',
+ 'name' => 'UserConfigDataSourceList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '清除当前缓存',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ 'title' => '用户数据源配置',
+ 'description' => '用户数据源配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Code' => ['title' => 'code描述', 'description' => 'code描述', 'type' => 'string', 'required' => true, 'example' => 'QuarkCommonNews'],
+ 'Name' => ['title' => '显示名称', 'description' => '显示名称', 'type' => 'string', 'required' => false, 'example' => '夸克通用搜索'],
+ 'Number' => ['title' => '数量', 'description' => '数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'],
+ 'Type' => ['title' => 'type类型', 'description' => 'type类型', 'type' => 'string', 'required' => true, 'example' => 'SystemSearch'],
+ 'Enable' => ['title' => '是否启用', 'description' => '是否启用', 'type' => 'boolean', 'required' => false],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
],
],
[
- 'name' => 'ModelName',
+ 'name' => 'GenerateTechnology',
'in' => 'formData',
- 'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus',
- ],
+ 'schema' => ['title' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
+ .'取值:"copilotPrecise","copilotReference"', 'description' => 'productCode=miaosou时,对应妙搜:生成技术'."\n"
+ ."\n"
+ .'可选值如下:'."\n"
+ ."\n"
+ .'- copilotPrecise'."\n"
+ ."\n"
+ .'- copilotReference', 'type' => 'string', 'required' => false, 'example' => 'copilotReference'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<Boolean>',
+ 'description' => 'PlainResult<Boolean>',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'b057f2fa-2277-477b-babf-cbc062307828',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '总结内容',
- 'type' => 'string',
- 'example' => '总结内容',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => '大模型token用量信息',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '3259D344-E871-5DE0-8FFE-CDA21F8D4382',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'true'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '保存信源权重配置',
+ 'summary' => '保存用户写作信源配置,通用搜索信源配置的配置信息。',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-08T10:53:00.000Z', 'description' => '请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveDataSourceOrderConfig'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveDataSourceOrderConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"92e16ccb-92b6-4894-abbf-fc6e2929a0df\\",\\n \\"TaskId\\": \\"b057f2fa-2277-477b-babf-cbc062307828\\",\\n \\"TraceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"总结内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"3259D344-E871-5DE0-8FFE-CDA21F8D4382\\"\\n}","type":"json"}]',
- 'title' => '文档摘要',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunDocWashing' => [
- 'summary' => '把一篇文章改换成指定风格。',
- 'path' => '/quanmiao/aimiaobi/runDocWashing',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SaveMaterialDocument' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'],
+ ],
+ [
+ 'name' => 'DocType',
'in' => 'formData',
'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
+ 'title' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
+ 'description' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
'type' => 'string',
'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
+ 'example' => 'excel',
+ 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine'],
],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'description' => '通道Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'required' => false, 'example' => '新闻标题'],
],
[
- 'name' => 'WritingTypeName',
+ 'name' => 'Author',
'in' => 'formData',
- 'schema' => [
- 'description' => '文体类型名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => '小红书文体'."\n"
- .'朋友圈文体'."\n"
- .'专业新闻文体'."\n"
- .'政府公文文体'."\n"
- .'报纸文章文体'."\n"
- .'意见信文体',
- ],
+ 'schema' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'required' => false, 'example' => '作者名称'],
],
[
- 'name' => 'WritingTypeRefDoc',
+ 'name' => 'PubTime',
+ 'in' => 'formData',
+ 'schema' => ['title' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-04-11 06:14:07'],
+ ],
+ [
+ 'name' => 'DocKeywords',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '文体示例文章',
- 'type' => 'string',
+ 'title' => '文档标签用于分类等',
+ 'description' => '文档标签用于分类等',
+ 'type' => 'array',
+ 'items' => ['description' => '关键词', 'type' => 'string', 'required' => false, 'example' => '关键词'],
'required' => false,
- 'example' => '该值若不为空则按该值优先',
],
],
[
- 'name' => 'ReferenceContent',
+ 'name' => 'Url',
'in' => 'formData',
- 'schema' => [
- 'description' => '要进行改写的文章',
- 'type' => 'string',
- 'required' => true,
- 'example' => '文章内容',
- ],
+ 'schema' => ['title' => '素材的URL', 'description' => '素材的URL', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx/xxx'],
],
[
- 'name' => 'Topic',
+ 'name' => 'ExternalUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '外部客户上传的URL,仅用作记录保存', 'description' => '外部客户上传的URL,仅用作记录保存', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx/xxx'."\n"],
+ ],
+ [
+ 'name' => 'SrcFrom',
'in' => 'formData',
'schema' => [
- 'description' => '改写文章主题',
+ 'title' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
+ 'description' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
'type' => 'string',
'required' => false,
- 'example' => '云南旅游主题',
+ 'example' => 'IntellijSearch',
+ 'enum' => ['UserUpload', 'IntellijSearch', 'HotViewPoint'],
],
],
[
- 'name' => 'WordNumber',
+ 'name' => 'TextContent',
+ 'in' => 'formData',
+ 'schema' => ['title' => '解析后的文本内容,对于图片来说为空', 'description' => '解析后的文本内容,对于图片来说为空', 'type' => 'string', 'required' => false, 'example' => '文本内容'],
+ ],
+ [
+ 'name' => 'HtmlContent',
+ 'in' => 'formData',
+ 'schema' => ['title' => '带格式的内容', 'description' => '带格式的内容', 'type' => 'string', 'required' => false, 'example' => '网页内容'],
+ ],
+ [
+ 'name' => 'ShareAttr',
'in' => 'formData',
'schema' => [
- 'description' => '改写后的字数要求',
+ 'title' => '共享属性:0:个人私有,1:业务空间范围内共享',
+ 'description' => '共享属性:0:个人私有,1:业务空间范围内共享',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'example' => '500',
+ 'example' => '1',
+ 'enum' => ['0', '1'],
],
],
[
- 'name' => 'Prompt',
+ 'name' => 'BothSavePrivateAndShare',
'in' => 'formData',
- 'schema' => [
- 'description' => '附加要求提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '按英文输出',
- ],
+ 'schema' => ['title' => '是否同时将素材保存为私有库与共享库', 'description' => '是否同时将素材保存为私有库与共享库', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'ModelId',
+ 'name' => 'Summary',
'in' => 'formData',
- 'schema' => [
- 'description' => '模型id',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
- ],
+ 'schema' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'required' => false, 'example' => '摘要'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<Long>',
+ 'description' => 'PlainResult<Long>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'End' => [
- 'description' => '响应包是否结束',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'task-finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'RequestId' => [
- 'description' => '请求RequestId',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '20247a52-23e2-46fb-943d-309cdee2bc6d',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'description' => '输出内容',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '保存素材',
+ 'summary' => '保存素材:保存素材库中素材。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveMaterialDocument'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveMaterialDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"Event\\": \\"task-finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"SessionId\\": \\"20247a52-23e2-46fb-943d-309cdee2bc6d\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\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 \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": 12,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
],
- 'RunBookIntroduction' => [
- 'summary' => '基于一本书,抽取书籍的内容概要,以及结构化的卖点、热词信息。',
- 'path' => '/miaodu/stream/runBookIntroduction',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SaveOrUpdateOssConfig' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-vtmox6g2bhq2qv5c',
- ],
- ],
- [
- 'name' => 'DocId',
+ 'name' => 'BucketName',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3YQRatoe8phnpIsIE6z7DTPknhG8Fj',
- ],
+ 'schema' => ['title' => 'oss的bucketName', 'description' => 'oss的bucketName', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'EndPoint',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0f56f98a-f2d8-47ec-98e9-1cbdcffa9539',
- ],
+ 'schema' => ['title' => 'oss的endPoint', 'description' => 'oss的endPoint', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-shanghai.aliyuncs.com'],
],
[
- 'name' => 'SummaryPrompt',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '总结自定义要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用英文输出',
- ],
- ],
- [
- 'name' => 'KeyPointPrompt',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '关键点自定义要求',
- 'type' => 'string',
- 'required' => false,
- 'example' => '用英文输出',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'],
],
],
'responses' => [
@@ -43240,210 +25350,108 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Header' => [
- 'description' => '响应头',
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Data' => [
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '411c4dfa-2168-4379-a902-675d67f453f8',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出内容对象',
- 'type' => 'object',
- 'properties' => [
- 'Summary' => [
- 'description' => '书籍简介',
- 'type' => 'string',
- 'example' => '简介内容',
- ],
- 'KeyPoint' => [
- 'description' => '书籍卖点',
- 'type' => 'string',
- 'example' => '卖点内容',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
- ],
+ 'BucketName' => ['title' => 'oss的bucketname', 'description' => 'oss的bucketname', 'type' => 'string', 'example' => 'xxx'],
+ 'Endpoint' => ['title' => 'oss的endpoint', 'description' => 'oss的endpoint', 'type' => 'string', 'example' => 'oss-cn-shanghai.aliyuncs.com'],
+ 'Enable' => ['title' => 'oss配置是否可用:1 可用,0 不可用', 'description' => 'oss配置是否可用:1 可用,0 不可用', 'type' => 'string', 'example' => '1'],
],
],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '配置-云存储-参数配置',
+ 'summary' => '配置-云存储-参数配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveOrUpdateOssConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"411c4dfa-2168-4379-a902-675d67f453f8\\",\\n \\"TaskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"TraceId\\": \\"46e5c2b5-0877-4f09-bd91-ab0cf314e48b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Summary\\": \\"简介内容\\",\\n \\"KeyPoint\\": \\"卖点内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
- 'title' => '书籍导读(抽取书籍卖点/书籍摘要)',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BucketName\\": \\"xxx\\",\\n \\"Endpoint\\": \\"oss-cn-shanghai.aliyuncs.com\\",\\n \\"Enable\\": \\"1\\"\\n }\\n}","type":"json"}]',
],
- 'RunBookBrainmap' => [
- 'summary' => '妙读生成书籍脑图。',
- 'path' => '/miaodu/stream/runBookBrainmap',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SaveStyleLearningResult' => [
+ 'summary' => '保存自定义文体。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'RewriteResult',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-hx72jf15gqyobvd9',
- ],
+ 'schema' => ['title' => '用户修订后内容', 'description' => '用户修订后内容', 'type' => 'string', 'required' => false, 'example' => '用户修订后内容'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'StyleName',
'in' => 'formData',
- 'schema' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '用户修订后内容', 'description' => '保存后的文体名称', 'type' => 'string', 'required' => false, 'example' => '学习报告'],
],
[
- 'name' => 'DocId',
+ 'name' => 'AigcResult',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '12345',
- ],
+ 'schema' => ['title' => 'AIGC 生成的内容', 'description' => 'AIGC 生成的内容', 'type' => 'string', 'required' => false, 'example' => 'AIGC 生成的内容'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'CustomTextIdList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '附加要求提示词',
- 'type' => 'string',
+ 'title' => '自定义素材ID',
+ 'description' => '自定义文本素材集合',
+ 'type' => 'array',
+ 'items' => ['description' => '1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '18'],
'required' => false,
- 'example' => '按英文输出',
],
],
[
- 'name' => 'CleanCache',
+ 'name' => 'AgentKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否清理掉之前的缓存',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => false, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'NodeNumber',
+ 'name' => 'TaskId',
'in' => 'formData',
- 'schema' => [
- 'description' => '第二级有几个节点',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '3',
- ],
+ 'schema' => ['title' => '任务唯一标识', 'description' => '任务id 和SSE接口中的taskID 保持一致', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
[
- 'name' => 'WordNumber',
+ 'name' => 'MaterialIdList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '节点文字的个数',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'description' => '素材ID集合',
+ 'type' => 'array',
+ 'items' => ['description' => '1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4'],
'required' => false,
- 'example' => '20',
],
],
],
@@ -43451,602 +25459,410 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'task-failed',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0bc1409b17210096103458421ec62e',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出内容对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '脑图内容',
- 'type' => 'string',
- 'example' => '{"xxxx":"xxx"}',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token消耗',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'true'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-failed\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0bc1409b17210096103458421ec62e\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"{\\\\\\"xxxx\\\\\\":\\\\\\"xxx\\\\\\"}\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
- 'title' => '书籍脑图',
- ],
- 'RunCommentGeneration' => [
- 'summary' => '针对指定文章,预测用户之声。',
- 'path' => '/quanmiao/aimiaobi/runCommentGeneration',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '保存文体学习分析结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SearchDatasetDocuments' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '路径参数,阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-3kcs1w3lltrtbfkr',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xx'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '搜索内容', 'description' => '搜索内容', 'type' => 'string', 'required' => true, 'example' => '搜索内容'],
],
[
- 'name' => 'Length',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'schema' => [
- 'description' => '一条评论的长度',
- 'type' => 'string',
- 'required' => false,
- 'example' => '20',
- ],
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识:和DatasetName二选一必选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'NumComments',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'schema' => [
- 'description' => '评论的条数',
- 'type' => 'string',
- 'required' => true,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => '数据集名称'],
],
[
- 'name' => 'Style',
+ 'name' => 'IncludeContent',
'in' => 'formData',
- 'schema' => [
- 'description' => '评论的风格',
- 'type' => 'string',
- 'required' => false,
- 'example' => '积极正面'."\n",
- ],
+ 'schema' => ['title' => '默认 false', 'description' => '是否包含正文:默认 false', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
[
- 'name' => 'SourceMaterial',
+ 'name' => 'Extend1',
'in' => 'formData',
- 'schema' => [
- 'description' => '要评论的文章',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'ps5是sony新一代的游戏机,他创新性的...'."\n",
- ],
+ 'schema' => ['title' => '业务参数', 'description' => '业务参数', 'type' => 'string', 'required' => false, 'example' => '业务参数'],
],
[
- 'name' => 'AllowEmoji',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否允许使用表情默认为false',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '返回数据条数', 'description' => '返回数据条数', 'type' => 'string', 'required' => false, 'example' => '10', 'default' => '10'],
],
[
- 'name' => 'Type',
+ 'name' => 'CategoryUuids',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '评论类型'."\n"
- ."\n"
- .' key 可选值'."\n"
- ."\n"
- .' * emotion (情感表达型)'."\n"
- .' * opinion (观点阐述型)'."\n"
- .' * interaction (互动交流型)'."\n"
- .' * experience (经验分享型)'."\n"
- .' * humor (幽默调侃型)',
- 'type' => 'object',
- 'required' => true,
- 'example' => '{"emotion":"50","opinion":"50"}'."\n",
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'required' => false,
+ 'description' => '',
],
],
[
- 'name' => 'Sentiment',
+ 'name' => 'Tags',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '情感倾向'."\n"
- ."\n"
- .' key 可选值'."\n"
- ."\n"
- .' * positive (正向)'."\n"
- .' * neutral (中立)'."\n"
- .' * negative (负向)',
- 'type' => 'object',
- 'required' => true,
- 'example' => '{"positive":"50","negative":"50"}'."\n",
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'required' => false,
+ 'description' => '',
],
],
[
- 'name' => 'LengthRange',
+ 'name' => 'Extend2',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'Extend3',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'CreateTimeStart',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'CreateTimeEnd',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'StartTime',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'EndTime',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'DocUuids',
'in' => 'formData',
'style' => 'json',
'schema' => [
- 'description' => '长度范围'."\n"
- ."\n"
- .' key 可选值'."\n"
- ."\n"
- .' * short (20字以内)'."\n"
- .' * medium (20-50字)'."\n"
- .' * long (50-100字)',
- 'type' => 'object',
- 'required' => true,
- 'example' => '{"short":"50","long":“50”}'."\n",
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
+ 'required' => false,
+ 'description' => '',
],
],
[
- 'name' => 'ExtraInfo',
+ 'name' => 'DocIds',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '补充要求',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
- 'example' => '不要输出额外其他信息'."\n",
+ 'description' => '',
],
],
[
- 'name' => 'ModelId',
+ 'name' => 'SearchMode',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
+ ],
+ [
+ 'name' => 'DocTypes',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '模型id',
- 'type' => 'string',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'required' => false, 'description' => ''],
'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
+ 'description' => '',
],
],
],
'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' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'End' => [
- 'description' => '是否结束',
- 'type' => 'boolean',
- ],
- 'Header' => [
- 'description' => '返回结果的header',
- 'type' => 'object',
- 'properties' => [
- 'Event' => [
- 'description' => 'event名称',
- 'type' => 'string',
- 'example' => 'result-generated'."\n",
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '可空'."\n",
- ],
- 'RequestId' => [
- 'description' => '请求RequestId',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'SessionId' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0bd58ea2-dc38-45da-ac02-17f05cb9040b',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- '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',
+ 'Documents' => [
+ 'title' => '文本数据',
+ 'description' => '文档列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文档列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocUuid' => ['title' => '内部文档唯一ID', 'description' => '文档系统唯一ID', 'type' => 'string', 'example' => 'xxx'],
+ 'Url' => ['description' => 'URL链接', 'type' => 'string', 'example' => 'xx'],
+ 'Content' => ['description' => '内容', 'type' => 'string', 'example' => 'xx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ 'Title' => ['description' => '标题', 'type' => 'string', 'example' => 'xx'],
+ 'PubTime' => ['description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-12-09 17:09:40'],
+ 'SourceFrom' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '来源'],
+ 'DocId' => ['title' => '用户指定的文档唯一ID', 'description' => '文档用户侧唯一ID', 'type' => 'string', 'example' => 'xx'],
+ 'DocType' => ['description' => '文档类型', 'type' => 'string', 'example' => 'text'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
+ 'Tags' => [
+ 'description' => '标签。',
+ 'type' => 'array',
+ 'items' => ['description' => '标签名称', 'type' => 'string', 'example' => 'xx'],
+ ],
+ 'SearchSourceType' => ['description' => '数据集类型', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSource' => ['description' => '数据集唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'SearchSourceName' => ['description' => '搜索信源名称', 'type' => 'string', 'example' => 'xx'],
+ 'Score' => ['description' => '阈值', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
+ 'ChunkInfos' => [
+ 'description' => '仅document 模式返回:文章维度相关chunk列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '片段',
+ 'type' => 'object',
+ 'properties' => [
+ 'Chunk' => ['description' => '片段', 'type' => 'string', 'example' => 'xx'],
+ 'Score' => ['description' => '阈值', 'type' => 'number', 'format' => 'double', 'example' => '0.77'],
+ ],
+ ],
+ ],
+ 'Chunk' => ['description' => '仅chunk 模式返回:片段', 'type' => 'string', 'example' => 'xx'],
],
],
],
],
],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-搜索文档',
+ 'summary' => '搜索数据源文档。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SearchDatasetDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": true,\\n \\"Header\\": {\\n \\"Event\\": \\"result-generated\\\\n\\",\\n \\"EventInfo\\": \\"可空\\\\n\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0bd58ea2-dc38-45da-ac02-17f05cb9040b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"评论内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 2,\\n \\"TotalTokens\\": 3\\n }\\n }\\n}","type":"json"}]',
- 'title' => '客户之声预测',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Documents\\": [\\n {\\n \\"DocUuid\\": \\"xxx\\",\\n \\"Url\\": \\"xx\\",\\n \\"Content\\": \\"xx\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Title\\": \\"xx\\",\\n \\"PubTime\\": \\"2024-12-09 17:09:40\\",\\n \\"SourceFrom\\": \\"来源\\",\\n \\"DocId\\": \\"xx\\",\\n \\"DocType\\": \\"text\\",\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"SearchSourceType\\": \\"xx\\",\\n \\"SearchSource\\": \\"xx\\",\\n \\"SearchSourceName\\": \\"xx\\",\\n \\"Score\\": 0.5,\\n \\"ChunkInfos\\": [\\n {\\n \\"Chunk\\": \\"xx\\",\\n \\"Score\\": 0.77\\n }\\n ],\\n \\"Chunk\\": \\"xx\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'RunHotword' => [
- 'summary' => '基于指定文章抽取关键词。关键词主要是指在特定领域或行业中具有代表性和识别度的专业术语或概念,它们能够精准地描述和概括某一行业内的核心内容、重要人物、关键事件或技术名词。',
- 'path' => '/miaodu/stream/runHotword',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SearchNews' => [
+ 'summary' => '根据输入检索新闻,目前仅支持互联网搜索。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-baw8as25ll3wnzjr',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~3027170~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'SearchSources',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '会话ID。',
- 'type' => 'string',
+ 'title' => '检索源列表',
+ 'description' => '检索源列表',
+ 'type' => 'array',
+ 'items' => ['description' => '搜索源code。非必填、目前仅支持:QuarkCommonNews。', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'],
'required' => false,
- 'example' => 'e32a1a3f-1f7e-41dd-b888-ef1d91b96d1e',
+ 'enumValueTitles' => [],
],
],
[
- 'name' => 'DocId',
+ 'name' => 'Query',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55',
- ],
+ 'schema' => ['title' => '检索Query', 'description' => '检索Query', 'type' => 'string', 'required' => false, 'example' => '检索Query'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'PageSize',
'in' => 'formData',
- 'schema' => [
- 'description' => '提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '提示词',
- ],
+ 'schema' => ['title' => '每页记录数', 'description' => '每页记录数,默认10', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
],
[
- 'name' => 'ReferenceContent',
+ 'name' => 'Page',
'in' => 'formData',
- 'schema' => [
- 'description' => '要从中提取热词的文档内容,不为空则按该内容提取,为空则按docId提取',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关联内容',
- ],
+ 'schema' => ['title' => '页码', 'description' => '当前页号。默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'ModelName',
+ 'name' => 'IncludeContent',
'in' => 'formData',
- 'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
- ],
+ 'schema' => ['title' => '是否包含正文', 'description' => '是否包含正文', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
+ ],
+ [
+ 'name' => 'FilterNotNull',
+ 'in' => 'formData',
+ 'schema' => ['title' => '是否过滤空内容', 'description' => '是否过滤空内容', 'type' => 'boolean', 'required' => false, 'example' => 'false'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PageResult',
+ 'description' => 'PageResult',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型。',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话id',
- 'type' => 'string',
- 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0abb7e3217356108993888059ee72b',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '热词内容',
- 'type' => 'string',
- 'example' => '全球影响,文化交流,孙悟空,动画改编',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '1',
- ],
- 'TotalTokens' => [
- 'description' => '总token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '101',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Current' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Data' => [
+ 'description' => '业务数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者(部分新闻可能没有)', 'type' => 'string', 'example' => '作者'],
+ 'Content' => ['title' => '内容', 'description' => '内容(必返回)', 'type' => 'string', 'example' => '文章内容'],
+ 'DocUuid' => ['title' => '内部文档唯一标识', 'description' => '内部文档唯一标识(必返回)', 'type' => 'string', 'example' => '9a598b44c6444da5907b8ea68a5f82c4'],
+ 'ImageUrls' => [
+ 'title' => '图片地址',
+ 'description' => '图片地址(已经不会返回,不建议使用)',
+ 'type' => 'array',
+ 'items' => ['description' => '新闻图像的URL。', 'type' => 'string', 'example' => 'https://www.example.com/aaaa.jpg'],
],
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间(必返回)', 'type' => 'string', 'example' => '2024-01-18 06:46:22'],
+ 'SearchSource' => ['title' => '搜索源', 'description' => '内部搜索源标识(必返回)', 'type' => 'string', 'example' => 'QuarkCommonNews'],
+ 'SearchSourceName' => ['title' => '搜索源名称', 'description' => '内部搜索源名称(必返回)', 'type' => 'string', 'example' => '夸克检索'],
+ 'Source' => ['title' => '来源', 'description' => '来源(部分新闻可能没有)', 'type' => 'string', 'example' => '央视网'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要(部分新闻可能没有)', 'type' => 'string', 'example' => '文章摘要'],
+ 'Tag' => ['title' => '标签', 'description' => '标签(部分新闻可能没有)', 'type' => 'string', 'example' => '文章标签'],
+ 'Title' => ['title' => '标题', 'description' => '标题(必返回)', 'type' => 'string', 'example' => '文章标题'],
+ 'UpdateTime' => ['title' => '系统更新时间', 'description' => '系统更新时间(已经不会返回,不建议使用)', 'type' => 'string', 'example' => '2024-01-18 06:46:22'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL(必返回)', 'type' => 'string', 'example' => '文章URL'],
],
],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Size' => ['description' => '每页记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Total' => ['description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '信息检索',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ['createdAt' => '2024-05-29T08:39:45.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SearchNews'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SearchNews',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"200\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"92e16ccb-92b6-4894-abbf-fc6e2929a0df\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"0abb7e3217356108993888059ee72b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"全球影响,文化交流,孙悟空,动画改编\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 1,\\n \\"TotalTokens\\": 101\\n }\\n }\\n}","type":"json"}]',
- 'title' => '抽取关键词',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"Author\\": \\"作者\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"DocUuid\\": \\"9a598b44c6444da5907b8ea68a5f82c4\\",\\n \\"ImageUrls\\": [\\n \\"https://www.example.com/aaaa.jpg\\"\\n ],\\n \\"PubTime\\": \\"2024-01-18 06:46:22\\",\\n \\"SearchSource\\": \\"QuarkCommonNews\\",\\n \\"SearchSourceName\\": \\"夸克检索\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Summary\\": \\"文章摘要\\",\\n \\"Tag\\": \\"文章标签\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"UpdateTime\\": \\"2024-01-18 06:46:22\\",\\n \\"Url\\": \\"文章URL\\"\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100\\n}","type":"json"}]',
],
- 'RunGenerateQuestions' => [
- 'summary' => '输入一个query,返回几个相关query。',
- 'path' => '/miaodu/stream/runGenerateQuestions',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SubmitAsyncTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -44054,329 +25870,197 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-w335gauzlbba2vze',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'TaskName',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'f486c4e2-b773-4d65-88f8-2ba540610456',
- ],
+ 'schema' => ['title' => '任务名称', 'description' => '任务名称定义', 'type' => 'string', 'required' => false, 'example' => '任务名称'],
],
[
- 'name' => 'DocId',
+ 'name' => 'TaskCode',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oOgIwodFANW1u5MnqxysOh1rtld3xn',
- ],
+ 'schema' => ['title' => '任务定义,可选值:MaterialDocumentUpload:素材上传', 'description' => '任务定义:详见任务定义表', 'type' => 'string', 'required' => true, 'example' => 'MaterialDocumentUpload'],
],
[
- 'name' => 'ReferenceContent',
+ 'name' => 'TaskParam',
'in' => 'formData',
- 'schema' => [
- 'description' => '要从中提取问题的文档内容,如果不为空则以此文本为准,为空则以docId为准',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关联内容',
- ],
+ 'schema' => ['title' => '任务提交参数', 'description' => '任务提交参数', 'type' => 'string', 'required' => false, 'example' => '{"fileUrl":"https://www.example.com/aaa.doc","fileName":"文件名称","shareAttr":1}'],
],
[
- 'name' => 'ModelName',
+ 'name' => 'TaskExecuteTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
- ],
+ 'schema' => ['title' => '任务执行时间,默认立即执行。格式:YYYY-MM-DD HH:mm:ss', 'description' => '任务执行时间,默认立即执行。格式:YYYY-MM-DD HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-10-14 14:30:00'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<SubmitTaskResult>',
+ 'description' => 'PlainResult<SubmitTaskResult>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Header' => [
- 'description' => '响应头',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'RateLimit',
- ],
- 'ErrorMessage' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => 'event名称',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0bc3b4b417362160345997589e5f6e',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '问题内容',
- 'type' => 'string',
- 'example' => '问题1\\n问题2\\n问题3\\n',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- 'InputTokens' => [
- 'description' => '输入使用的Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'OutputTokens' => [
- 'description' => '输出Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总oken数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '200',
- ],
- ],
- ],
+ 'TaskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => 'xxxx'],
+ 'TaskIntermediateResult' => ['title' => '中间结果', 'description' => '中间结果', 'type' => 'any', 'example' => '{}'],
+ 'TaskName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => '任务名称'],
],
],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'successful'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交异步任务',
+ 'summary' => '执行系统预定义的异步任务。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitAsyncTask'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"RateLimit\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"3cd10828-0e42-471c-8f1a-931cde20b035\\",\\n \\"TaskId\\": \\"d3be9981-ca2d-4e17-bf31-1c0a628e9f99\\",\\n \\"TraceId\\": \\"0bc3b4b417362160345997589e5f6e\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"问题1\\\\\\\\n问题2\\\\\\\\n问题3\\\\\\\\n\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n }\\n}","type":"json"}]',
- 'title' => '猜你想问',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxx\\",\\n \\"TaskIntermediateResult\\": \\"{}\\",\\n \\"TaskName\\": \\"任务名称\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunDocQa' => [
- 'summary' => '文章问答:针对一个自然语言类的query,在指定的文章范围内给出文字答案(有图则会配图),并显示溯源信息。'."\n"
- .'多模态文件问答:针对一个自然语言类的query,在指定的多模态文件范围内给出文字答案,并带上相关的图片、视频片段或者文字,并显示溯源信息。',
- 'path' => '/miaodu/stream/runDocQA',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SubmitAuditNote' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeNodes' => [
- 'FEATUREsfmJIZ0TW',
- ],
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间 ID。获取方式请参见[如何使用业务空间](~~2782167~~)。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-dswd4003ny4gh9rw',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'SearchSource',
+ 'name' => 'FileKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '搜索源',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'fromIndexLib' => '基于整个文档库进行问答',
- 'fromWeb' => '基于互联网搜索进行问答',
- 'fromRefContent' => '基于ReferenceContent字段进行问答',
- 'fromDoc' => '基于给出的文档Id进行文档问答',
- ],
- 'example' => 'fromWeb',
- ],
+ 'schema' => ['title' => '阿里云 OSS 存储中,用户上传的规则库文件对应的 FileKey。规则库文件只允许使用 docx, xlsx, pdf 格式,其中 xlsx 格式限制两列,且表头必须为“审校依据”和“依据出处”。上传 xlsx 格式能有更好的解析效果,但 docx 和 pdf 也会由系统自动解析。', 'description' => '阿里云 OSS 存储中,用户上传的规则库文件对应的 FileKey(注意:FileKey 生成方式见 [通用接口-文件上传下载GenerateUploadConfig - 生成上传配置](https://next.api.aliyun.com/document/AiMiaoBi/2023-08-01/GenerateUploadConfig?spm=openapi-amp.newDocPublishment.0.0.18fc281fOiiBil))。规则库文件只允许使用 docx, xlsx, pdf 格式,其中 xlsx 格式限制两列,且表头必须为“审校依据”和“依据出处”。上传 xlsx 格式能有更好的解析效果,但 docx 和 pdf 也会由系统自动解析。', 'type' => 'string', 'required' => true, 'example' => 'oss://default/your/file/key'],
],
[
- 'name' => 'DocIds',
+ 'name' => 'NoteId',
'in' => 'formData',
- 'style' => 'json',
+ 'schema' => ['title' => '规则库ID(不填默认是 Default )', 'description' => '规则库ID(不填默认是 Default )', 'type' => 'string', 'required' => false, 'example' => 'note_id_unique'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '多个文档Id数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '文档Id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '10022',
+ '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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '本次提交规则库的任务 ID(taskId / TaskId),供之后的接口调用使用。', 'description' => '本次提交规则库的任务 ID(taskId / TaskId),供之后的接口调用使用。', 'type' => 'string', 'example' => 'xxx_Default_89123748917'],
],
- 'required' => false,
],
],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交自定义规则库',
+ 'summary' => '妙笔为您提供了与公有云“智能审校”模块中相同的上传自定义规则库的功能。由于鉴权限制,用户需要使用自定义规则库文件的 fileKey 作为入参才能顺利调用本接口。该接口在被调用后,会对用户的自定义规则库进行结构化处理,并生成一个 xlsx 格式的结构化解析结果。您可以调用 GetAuditNoteProcessingStatus 接口查询结构化处理状态,也可以调用 DownloadAuditNote 接口获取结构化之后的规则库。接口功能正在迭代中,预计会在未来使用可访问的文件 URL 作为入参。',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
[
- 'name' => 'Query',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '问题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '苹果16手机什么时候发布',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"xxx_Default_89123748917\\"\\n}","type":"json"}]',
+ ],
+ 'SubmitAuditTask' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- 'name' => 'ReferenceContent',
+ 'AK' => [],
+ ],
+ ],
+ 'operationType' => 'readAndWrite',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
+ 'parameters' => [
+ [
+ 'name' => 'ArticleId',
'in' => 'formData',
- 'schema' => [
- 'description' => '提问者主动提供的关联内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '关联内容',
- ],
+ 'schema' => ['title' => '审核时的文章ID', 'description' => '审核时的文章ID', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'ConversationContexts',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '历史上下文内容数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '历史上下文',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '问答内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '问答内容',
- ],
- 'Role' => [
- 'description' => '角色',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'user',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Content',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'f486c4e2-b773-4d65-88f8-2ba540610456',
- ],
+ 'schema' => ['title' => '待审核的内容', 'description' => '待审核的内容', 'type' => 'string', 'required' => false, 'example' => '待审核的内容'."\n"
+ ."\n"],
],
[
- 'name' => 'CategoryIds',
+ 'name' => 'HtmlContent',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'description' => '过滤目录Id数组,只在SearchSource为fromIndexLib时有效',
- 'type' => 'array',
- 'items' => [
- 'description' => '类目ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'default',
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '审核时的 HTML格式 的内容', 'description' => '审核时的 HTML格式 的内容', 'type' => 'string', 'required' => false, 'example' => '待审核的内容(HTML格式)'],
],
[
- 'name' => 'ModelName',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
- ],
+ 'schema' => ['title' => '审核时的文章标题', 'description' => '审核时的文章标题', 'type' => 'string', 'required' => false, 'example' => '审核时的文章标题'."\n"
+ ."\n"],
],
],
'responses' => [
@@ -44386,229 +26070,50 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => 'f5517ee8-dbec-4dc8-bd0a-af084b5e3db1',
- ],
- 'TaskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
+ 'Data' => [
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '回答内容',
- 'type' => 'string',
- 'example' => '回答内容',
- ],
- 'InterveneContent' => [
- 'description' => '干预后的回答内容',
- 'type' => 'string',
- 'example' => '干预后的回答内容',
- ],
- 'IsReject' => [
- 'description' => '是否拒识',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
- 'MediaUrlList' => [
- 'description' => '多模态资源信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '多模态资源对象',
- 'type' => 'object',
- 'properties' => [
- 'ClipInfos' => [
- 'description' => '相关视频时间信息数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '相关视频时间信息',
- 'type' => 'object',
- 'properties' => [
- 'From' => [
- 'description' => '视频片段开始时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0',
- ],
- 'To' => [
- 'description' => '视频片段结束时间',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '30',
- ],
- ],
- ],
- ],
- 'FileUrl' => [
- 'description' => '文件url',
- 'type' => 'string',
- 'example' => 'https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg',
- ],
- 'MediaType' => [
- 'description' => '媒资媒体类型',
- 'type' => 'string',
- 'example' => 'video',
- ],
- ],
- ],
- ],
- 'Recommends' => [
- 'description' => '推荐内容数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '推荐内容',
- 'type' => 'object',
- 'properties' => [
- 'Title' => [
- 'description' => '推荐内容标题',
- 'type' => 'string',
- 'example' => '标题内容',
- ],
- 'Url' => [
- 'description' => '推荐内容url',
- 'type' => 'string',
- 'example' => '推荐内容url',
- ],
- ],
- ],
- ],
- 'References' => [
- 'description' => '回答内容来源数组',
- 'type' => 'array',
- 'items' => [
- 'description' => '回答内容来源',
- 'type' => 'object',
- 'properties' => [
- 'PubTime' => [
- 'description' => '发布时间',
- 'type' => 'string',
- 'example' => '2024-10-08 18:00',
- ],
- 'Source' => [
- 'description' => '来源',
- 'type' => 'string',
- 'example' => '新浪新闻',
- ],
- 'SourceDocId' => [
- 'description' => '来源docId',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'Title' => [
- 'description' => '关联内容标题',
- 'type' => 'string',
- 'example' => '标题内容',
- ],
- 'Url' => [
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'http://xxxxx',
- ],
- ],
- ],
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xx'],
],
],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交审核任务',
+ 'summary' => '提交审核任务',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](https://alidocs.dingtalk.com/i/nodes/m9bN7RYPWdyrPBREcyM6jDQ2VZd1wyK0?cid=116617178%3A898142682&utm_source=im&utm_scene=team_space&iframeQuery=utm_medium%3Dim_card%26utm_source%3Dim&utm_medium=im_card&corpId=dingd8e1123006514592)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitAuditTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"f5517ee8-dbec-4dc8-bd0a-af084b5e3db1\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"46e5c2b5-0877-4f09-bd91-ab0cf314e48b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"回答内容\\",\\n \\"InterveneContent\\": \\"干预后的回答内容\\",\\n \\"IsReject\\": false,\\n \\"MediaUrlList\\": [\\n {\\n \\"ClipInfos\\": [\\n {\\n \\"From\\": 0,\\n \\"To\\": 30\\n }\\n ],\\n \\"FileUrl\\": \\"https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg\\",\\n \\"MediaType\\": \\"video\\"\\n }\\n ],\\n \\"Recommends\\": [\\n {\\n \\"Title\\": \\"标题内容\\",\\n \\"Url\\": \\"推荐内容url\\"\\n }\\n ],\\n \\"References\\": [\\n {\\n \\"PubTime\\": \\"2024-10-08 18:00\\",\\n \\"Source\\": \\"新浪新闻\\",\\n \\"SourceDocId\\": \\"123456\\",\\n \\"Title\\": \\"标题内容\\",\\n \\"Url\\": \\"http://xxxxx\\"\\n }\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n}","type":"json"}]',
- 'title' => '文档问答(文章问答/多模态文件问答)',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xx\\"\\n }\\n}","type":"json"}]',
],
- 'RunDocTranslation' => [
- 'summary' => '中英文互译接口。',
- 'path' => '/miaodu/stream/runDocTranslation',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SubmitCustomHotTopicBroadcastJob' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -44616,215 +26121,140 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'HotTopicBroadcastConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
+ 'title' => '新闻播报单配置',
+ 'description' => '新闻播报单配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'StepForNewsBroadcastContentConfig' => [
+ 'title' => '配置播报单内容',
+ 'description' => '配置播报单内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'Categories' => [
+ 'title' => '选择的频道列表',
+ 'description' => '选择的频道列表',
+ 'type' => 'array',
+ 'items' => ['description' => '频道', 'type' => 'string', 'required' => false, 'example' => '科技'],
+ 'required' => false,
+ 'example' => '["科技","经济","时政","娱乐"]',
+ ],
+ 'CustomHotValueWeights' => [
+ 'title' => '自定义热度权重',
+ 'description' => '自定义热度权重',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '自定义权重',
+ 'type' => 'object',
+ 'properties' => [
+ 'Dimension' => ['title' => '维度KEY', 'description' => '维度KEY', 'type' => 'string', 'required' => false, 'example' => 'views'],
+ 'DimensionName' => ['title' => '维度名称', 'description' => '维度名称', 'type' => 'string', 'required' => false, 'example' => '维度名称'],
+ 'Weight' => ['title' => '权重', 'description' => '权重', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'TopicCount' => ['title' => '话题数量', 'description' => '话题数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ 'required' => true,
+ ],
+ 'StepForCustomSummaryStyleConfig' => [
+ 'title' => '自定义输出风格配置',
+ 'description' => '自定义输出风格配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'SummaryImageCount' => ['title' => '摘要-配图数量', 'description' => '摘要-配图数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ 'SummaryModel' => ['title' => '摘要模型', 'description' => '摘要模型', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'],
+ 'SummaryPrompt' => ['title' => '摘要-自定义Prompt', 'description' => '摘要-自定义Prompt', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ 'required' => true,
+ ],
+ ],
'required' => true,
- 'example' => '2e6b3987-f743-4d4c-8326-d9c41a6af3ee',
],
],
[
- 'name' => 'DocId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '12345',
- ],
- ],
- [
- 'name' => 'TransType',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '翻译方式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'toChinese'."\n"
- .'toEnglish'."\n"
- .'toJapenese'."\n"
- .'toRussian'."\n"
- .'toFrench'."\n"
- .'toGerman'."\n"
- .'toItalian'."\n"
- .'toKorean'."\n"
- .'toSpanish'."\n"
- .'toPortuguese',
- ],
- ],
- [
- 'name' => 'RecommendContent',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '要翻译的内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '要翻译的内容',
- ],
- ],
- [
- 'name' => 'CleanCache',
+ 'name' => 'HotTopicVersion',
'in' => 'formData',
- 'schema' => [
- 'description' => '是否清除当前缓存',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'schema' => ['title' => '热点版本', 'description' => '热点版本', 'type' => 'string', 'required' => false, 'example' => '热点版本'],
],
[
- 'name' => 'ModelName',
+ 'name' => 'Topics',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
+ 'title' => '话题筛选',
+ 'description' => '话题筛选',
+ 'type' => 'array',
+ 'items' => ['description' => '热点主题名称', 'type' => 'string', 'required' => false, 'example' => '热点主题名称'],
'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult',
+ 'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误码消息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '411c4dfa-2168-4379-a902-675d67f453f8',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '50a1cc8e-717e-4a2b-a76b-dc9734a8564b',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => 'ebd19b12-0cae-488f-9e41-5a1c825f545b',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '翻译内容',
- 'type' => 'string',
- 'example' => '翻译内容',
- ],
- ],
- ],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
- ],
+ 'TaskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
+ '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'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交自定义播报单任务',
+ 'summary' => '提交自定义播报单任务。',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-13T13:21:01.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitCustomHotTopicBroadcastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"task-started\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"411c4dfa-2168-4379-a902-675d67f453f8\\",\\n \\"TaskId\\": \\"50a1cc8e-717e-4a2b-a76b-dc9734a8564b\\",\\n \\"TraceId\\": \\"ebd19b12-0cae-488f-9e41-5a1c825f545b\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"翻译内容\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\"\\n}","type":"json"}]',
- 'title' => '文档翻译',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'RunDocSmartCard' => [
- 'summary' => '针对划选的文字或指定chat,自动打标并生成一个卡片笔记。',
- 'path' => '/miaodu/stream/runDocSmartCard',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'SubmitCustomSourceTopicAnalysis' => [
+ 'summary' => '从自定义数据源提交选题热点分析',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -44832,371 +26262,336 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'FileUrl',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-2setzb9x4ewsd',
- ],
+ 'schema' => ['title' => '文件URL(FileUrl与News二选一)', 'description' => '文件URL(FileUrl与News二选一)(文件的结构请参考 News字段)', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxx.json'],
],
[
- 'name' => 'DocId',
+ 'name' => 'FileType',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55',
- ],
+ 'schema' => ['title' => '文件类型', 'description' => '文件类型(json: json数组格式,jsonLine:json行格式)', 'type' => 'string', 'required' => false, 'example' => 'json'],
],
[
- 'name' => 'SessionId',
+ 'name' => 'MaxTopicSize',
+ 'in' => 'formData',
+ 'schema' => ['title' => '最大分析的话题数量', 'description' => '最大分析的话题数量(默认情况下 会按照聚类后的新闻数量倒排,取TOP50 进行话题分析,最大200条 )', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'],
+ ],
+ [
+ 'name' => 'News',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'title' => '新闻列表(FileUrl与News二选一)',
+ 'description' => '新闻列表(FileUrl与News二选一)',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '新闻对象',
+ 'description' => '新闻对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Title' => ['title' => '新闻标题 ', 'description' => '新闻标题 ', 'type' => 'string', 'required' => false, 'example' => '新闻标题'],
+ 'Content' => ['title' => '新闻正文', 'description' => '新闻正文', 'type' => 'string', 'required' => false, 'example' => '新闻正文'."\n"
+ ."\n"],
+ 'Url' => ['title' => '新闻URL', 'description' => '新闻URL', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxx.html'."\n"],
+ 'Comments' => [
+ 'title' => '评论列表',
+ 'description' => '评论列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '评论对象',
+ 'description' => '评论对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '评论内容', 'description' => '评论内容', 'type' => 'string', 'required' => false, 'example' => '评论内容'."\n"
+ ."\n"],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'PubTime' => ['title' => '发布时间(格式为: YYYY-MM-dd HH:mm:ss)', 'description' => '发布时间(格式为: YYYY-MM-dd HH:mm:ss)', 'type' => 'string', 'required' => false, 'example' => '2024-01-22 10:29:00'],
+ 'Source' => ['title' => '新闻来源', 'description' => '新闻来源', 'type' => 'string', 'required' => false, 'example' => '百度'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'Prompt',
+ 'name' => 'WorkspaceId',
'in' => 'formData',
+ 'schema' => ['title' => '百炼业务空间ID', 'description' => '[百炼业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
+ ],
+ [
+ 'name' => 'AnalysisTypes',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '提示词',
- 'type' => 'string',
+ 'title' => '选题热点要分析的类型(多选,不传默认分析全部。 传空数组,默认不做选题热点分析,仅聚类。)'."\n"
+ .'HotViewPoints: 热门选题视角分析'."\n"
+ .'WebReviewPoints: 网友选题视角分析(需要有评论)'."\n"
+ .'TimedViewPoints:时效性选题视角分析'."\n"
+ .'FreshViewPoints:新颖视角分析'."\n"
+ .'TopicSummary:新闻摘要分析'."\n",
+ 'description' => '选题热点要分析的类型(多选,不传默认分析全部。 传空数组,默认不做选题热点分析,仅聚类。)'."\n"
+ .'HotViewPoints: 热门选题视角分析'."\n"
+ .'WebReviewPoints: 网友选题视角分析(需要有评论)'."\n"
+ .'TimedViewPoints:时效性选题视角分析'."\n"
+ .'FreshViewPoints:新颖视角分析'."\n"
+ .'TopicSummary:新闻摘要分析'."\n",
+ 'type' => 'array',
+ 'items' => ['description' => '选题热点要分析的类型', 'type' => 'string', 'required' => false, 'example' => 'TimedViewPoints'],
'required' => false,
- 'example' => '自定义提示词',
],
],
[
- 'name' => 'ModelName',
+ 'name' => 'Topics',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '用户自定义模型名称',
- 'type' => 'string',
+ 'title' => '话题列表',
+ 'description' => '话题列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '话题对象',
+ 'description' => '话题对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Topic' => ['title' => '话题名称', 'description' => '话题名称', 'type' => 'string', 'required' => false, 'example' => '话题名称'],
+ 'News' => [
+ 'title' => '新闻列表(为空时通过夸克检索补足,数量默认10篇)',
+ 'description' => '新闻列表',
+ 'type' => 'array',
+ 'items' => ['title' => '新闻对象', 'description' => '新闻对象', 'required' => false, '$ref' => '#/components/schemas/HottopicNews'],
+ 'required' => false,
+ ],
+ 'CustomField' => ['title' => '自定义业务字段(keyword),用于按业务维度筛选话题,长度上限 255 字符', 'description' => '自定义字段,后续可以根据 ListHotTopics 接口使用该字段筛选。', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'maxLength' => 255],
+ 'TopicUrl' => ['title' => '话题原文链接', 'description' => '话题URL,无其他作用,仅供 ListHotTopics透传作用', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/topic/123'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'quanmiao-max、quanmiao-plus'."\n",
],
],
+ [
+ 'name' => 'TopicsFileUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '话题列表URL(使用 json line 格式,每行是一个json)', 'description' => '话题列表URL(使用 json line 格式,每行是一个json)', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxx.jsonline'],
+ ],
],
'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' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Header' => [
- 'description' => '响应头',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '通话唯一ID',
- 'type' => 'string',
- 'example' => '07181f55-2311-48af-8048-132a77dee020',
- ],
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => '8d55b429d7c6d321fcff54823e8d317b',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0abb781c17337107444473701ed7c3',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出内容对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '卡片标题',
- 'type' => 'string',
- 'example' => '标题内容',
- ],
- 'Tags' => [
- 'description' => '卡片标签数组',
- 'type' => 'array',
- 'items' => [
- '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' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '101',
- ],
- ],
- ],
+ 'TaskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => '任务名称'],
],
],
+ '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'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"07181f55-2311-48af-8048-132a77dee020\\",\\n \\"TaskId\\": \\"8d55b429d7c6d321fcff54823e8d317b\\",\\n \\"TraceId\\": \\"0abb781c17337107444473701ed7c3\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"标题内容\\",\\n \\"Tags\\": [\\n \\"标签内容\\"\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 101\\n }\\n }\\n}","type":"json"}]',
- 'title' => '文档智能卡片',
- ],
- 'RunBookSmartCard' => [
- 'summary' => '书籍智能卡片接口。',
- 'path' => '/miaodu/stream/runBookSmartCard',
- 'methods' => [
- 'post',
+ 'title' => '提交自定义源话题选题分析任务',
+ 'requestParamsDescription' => '支持两种分析模式'."\n"
+ .'1. 传 一批文章,进行 新闻聚类 -> 然后进行 选题策划分析'."\n"
+ .' 1. 待分析的内容为 新闻列表 对象 具体结构 请参考:News字段。'."\n"
+ .' 2. News字段与fileUrl字段二选一'."\n"
+ .' 3. 支持分析的新闻数最大支持 1w条新闻。 '."\n"
+ .' 4. 支持最大 产出的聚合话题 200个。由参数:MaxTopicSize控制。'."\n"
+ ."\n"
+ .'2. 从聚类好的新闻 直接进行选题策划分析'."\n"
+ .' 1. 待分析的内容为 话题列表 对象 具体结构 请参考:Topics字段'."\n"
+ .' 2. Topics字段与TopicsFileUrl字段二选一'."\n"
+ ."\n"
+ .'3. 支持将分析结果导出为 json 或者 excel。参考[导出接口](~~2929476~~)的ExportType字段'."\n"
+ ."\n"
+ .'4. 最佳实践请参考:[妙策自定义数据源最佳实践](https://help.aliyun.com/zh/model-studio/best-practices-for-miaoce-api?spm=a2c4g.11186623.help-menu-2400256.d_1_12_6_2_1_1.6acd4b9e5922F7&scm=20140722.H_2848246._.OR_help-T_cn~zh-V_1#42209ec83blza)'."\n"
+ ."\n\n"
+ .'fileUrl示例格式为:'."\n"
+ .'```json'."\n"
+ ."\n"
+ .'['."\n"
+ .' {'."\n"
+ .' "Content": "这是一篇关于人工智能技术的示例文章。人工智能正在快速发展,在各个领域都有广泛应用。从自动驾驶到医疗诊断,AI技术正在改变我们的生活方式。",'."\n"
+ .' "Title": "人工智能技术的发展趋势",'."\n"
+ .' "Source": "科技日报"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "Content": "随着气候变化问题日益严重,可再生能源成为全球关注的焦点。太阳能、风能等清洁能源技术的进步,为解决环境问题提供了新的可能。",'."\n"
+ .' "Title": "可再生能源的未来",'."\n"
+ .' "Source": "环保周刊"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "Content": "5G技术的推广为物联网应用带来了新的机遇。智能家居、智慧城市等概念正在从科幻走向现实,改变着我们与世界的交互方式。",'."\n"
+ .' "Title": "5G与物联网的融合发展",'."\n"
+ .' "Source": "通信世界"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "Content": "随着人们健康意识的提高,运动健身产业迎来快速发展。从传统的健身房到新兴的在线健身平台,多样化的运动方式满足了不同人群的需求。",'."\n"
+ .' "Title": "运动健身产业的崛起",'."\n"
+ .' "Source": "健康生活"'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "Content": "短视频平台的兴起改变了内容消费模式。用户通过简短的视频片段获取信息和娱乐,这种碎片化的传播方式对传统媒体产生了深远影响。",'."\n"
+ .' "Title": "短视频时代的内容变革",'."\n"
+ .' "Source": "媒体观察"'."\n"
+ .' }'."\n"
+ .']'."\n"
+ ."\n"
+ .'```',
+ 'changeSet' => [
+ ['createdAt' => '2025-06-26T12:18:54.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitCustomSourceTopicAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SubmitCustomTopicSelectionPerspectiveAnalysisTask' => [
+ 'summary' => '提交自定义热点选题视角分析任务。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Documents',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xxx',
+ 'title' => '待分析的文档列表。',
+ 'description' => '待分析的文档列表。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'required' => false, 'example' => '作者', 'maxLength' => 100],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => true, 'example' => '文章内容', 'maxLength' => 3000, 'minLength' => 30],
+ 'PubTime' => ['title' => '发布时间。格式:YYYY-MM-dd HH:mm:ss', 'description' => '发布时间。格式:YYYY-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2024-01-22 10:29:00', 'maxLength' => 19],
+ 'Source' => ['title' => '文章来源', 'description' => '文章来源', 'type' => 'string', 'required' => false, 'example' => '新浪', 'maxLength' => 40],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'required' => false, 'example' => '文章摘要', 'maxLength' => 200],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '文章标题', 'maxLength' => 100],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx', 'maxLength' => 1024],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ 'maxItems' => 30,
],
],
[
- 'name' => 'DocId',
+ 'name' => 'Topic',
'in' => 'formData',
- 'schema' => [
- 'description' => '文档ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55',
- ],
+ 'schema' => ['title' => '待分析的主题名', 'description' => '待分析的主题名', 'type' => 'string', 'required' => false, 'example' => '待分析的主题名(documents与topic二者至少传一个)', 'maxLength' => 1000],
],
[
- 'name' => 'SessionId',
+ 'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '对话ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'schema' => ['title' => '自定义观点的输入Prompt', 'description' => '自定义观点的输入Prompt', 'type' => 'string', 'required' => true, 'example' => '自定义观点的输入Prompt', 'maxLength' => 2000],
],
],
'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' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5',
- ],
- 'Header' => [
- 'description' => '响应头',
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'finished',
- ],
- 'EventInfo' => [
- 'description' => '事件描述',
- 'type' => 'string',
- 'example' => '模型生成事件',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '1a0e898717105546647125853d4f54',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Output' => [
- 'description' => '输出内容对象',
- 'type' => 'object',
- 'properties' => [
- 'Content' => [
- 'description' => '卡片标题',
- 'type' => 'string',
- 'example' => '卡片标题内容',
- ],
- 'Tags' => [
- 'description' => '卡片标签数组',
- 'type' => 'array',
- 'items' => [
- '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' => '100',
- ],
- 'TotalTokens' => [
- 'description' => '总Token数量',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '101',
- ],
- ],
- ],
+ 'TaskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
+ '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'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交自定义热点选题视角分析任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitCustomTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"success\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"Event\\": \\"finished\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TraceId\\": \\"1a0e898717105546647125853d4f54\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Content\\": \\"卡片标题内容\\",\\n \\"Tags\\": [\\n \\"卡片标签内容\\"\\n ]\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 1,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 101\\n }\\n }\\n}","type":"json"}]',
- 'title' => '书籍智能卡片',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
'SubmitDeepWriteTask' => [
- 'summary' => '提交深度写作任务。'."\n"
- .'用户可以根据要研究或分析的主题,填入问题、指令、附件等信息,来提交深度写作任务。该任务会在系统后台调度和执行。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -45204,44 +26599,22 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-1setzb9xb8m11vrc',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-1setzb9xb8m11vrc'],
],
[
'name' => 'Input',
'in' => 'formData',
- 'schema' => [
- 'title' => '用户的问题',
- 'description' => '用户的问题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '北京2025年新能源汽车发展趋势',
- ],
+ 'schema' => ['title' => '用户的问题', 'description' => '用户的问题', 'type' => 'string', 'required' => true, 'example' => '北京2025年新能源汽车发展趋势'],
],
[
'name' => 'Instructions',
'in' => 'formData',
- 'schema' => [
- 'title' => '指令',
- 'description' => '指令',
- 'type' => 'string',
- 'required' => false,
- 'example' => '请根据北京新能源汽车在汽车品牌、新车发布、能源等方面进行分析',
- ],
+ 'schema' => ['title' => '指令', 'description' => '指令', 'type' => 'string', 'required' => false, 'example' => '请根据北京新能源汽车在汽车品牌、新车发布、能源等方面进行分析'],
],
[
'name' => 'Files',
@@ -45254,32 +26627,12 @@
'items' => [
'type' => 'object',
'properties' => [
- 'FileKey' => [
- 'title' => '附件的OSS地址',
- 'description' => '附件的OSS地址',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-poc/aimiaobi/deep-write-upload/1_1/xxx.txt',
- 'maxLength' => 500,
- ],
- 'FileDescription' => [
- 'title' => '附件的备注',
- 'description' => '附件的备注',
- 'type' => 'string',
- 'required' => false,
- 'example' => '附件的说明',
- 'maxLength' => 500,
- ],
- 'FileName' => [
- 'title' => '附件的名称',
- 'description' => '附件的名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '附件的名称',
- 'maxLength' => 200,
- ],
+ 'FileKey' => ['title' => '附件的OSS地址', 'description' => '附件的OSS地址', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-poc/aimiaobi/deep-write-upload/1_1/xxx.txt', 'maxLength' => 500],
+ 'FileDescription' => ['title' => '附件的备注', 'description' => '附件的备注', 'type' => 'string', 'required' => false, 'example' => '附件的说明', 'maxLength' => 500],
+ 'FileName' => ['title' => '附件的名称', 'description' => '附件的名称', 'type' => 'string', 'required' => false, 'example' => '附件的名称', 'maxLength' => 200],
],
'required' => false,
+ 'description' => '',
],
'required' => false,
],
@@ -45296,13 +26649,7 @@
'description' => '数据收集智能体',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DataCollectorAgent',
- 'default' => 'DataCollectorAgent',
- ],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'DataCollectorAgent', 'default' => 'DataCollectorAgent'],
],
'required' => false,
],
@@ -45310,19 +26657,8 @@
'description' => '数据分析智能体',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DataAnalystAgent',
- 'default' => 'DataAnalystAgent',
- ],
- 'EnableSearch' => [
- 'description' => '开启检索',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'DataAnalystAgent', 'default' => 'DataAnalystAgent'],
+ 'EnableSearch' => ['description' => '开启检索', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
'required' => false,
],
@@ -45330,18 +26666,8 @@
'description' => '报告智能体',
'type' => 'object',
'properties' => [
- 'Name' => [
- 'description' => '名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ReporterAgent',
- 'default' => 'ReporterAgent',
- ],
- 'EnableCitation' => [
- 'description' => '开启引用',
- 'type' => 'boolean',
- 'required' => false,
- ],
+ 'Name' => ['description' => '名称', 'type' => 'string', 'required' => false, 'example' => 'ReporterAgent', 'default' => 'ReporterAgent'],
+ 'EnableCitation' => ['description' => '开启引用', 'type' => 'boolean', 'required' => false],
],
'required' => false,
],
@@ -45357,59 +26683,22 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
'title' => '任务响应对象',
'description' => '任务响应对象',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'xbabac91-fdad-44d6-95ce-******',
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xbabac91-fdad-44d6-95ce-******'],
'Status' => [
'title' => '任务状态',
'description' => '任务状态',
'type' => 'string',
- 'enumValueTitles' => [
- 'in_progress' => '运行中',
- 'queued' => '排队中',
- 'cancelled' => '已取消',
- 'completed' => '已完成',
- 'failed' => '失败',
- ],
+ 'enumValueTitles' => ['in_progress' => '运行中', 'queued' => '排队中', 'cancelled' => '已取消', 'completed' => '已完成', 'failed' => '失败'],
'example' => 'queued',
],
],
@@ -45418,148 +26707,136 @@
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交深度写作任务',
+ 'summary' => '提交深度写作任务。'."\n"
+ .'用户可以根据要研究或分析的主题,填入问题、指令、附件等信息,来提交深度写作任务。该任务会在系统后台调度和执行。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitDeepWriteTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xbabac91-fdad-44d6-95ce-******\\",\\n \\"Status\\": \\"queued\\"\\n }\\n}","type":"json"}]',
- 'title' => '提交深度写作任务',
],
- 'GetDeepWriteTask' => [
- 'summary' => '查询深度写作任务。'."\n"
- .'主要用来查询指定任务的运行状态。',
+ 'SubmitDocClusterTask' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Documents',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-odl2p61i4vfbph4g',
+ 'title' => '文档列表',
+ 'description' => '文档列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Content' => ['title' => '文档内容', 'description' => '文档内容', 'type' => 'string', 'required' => true, 'example' => '文档内容', 'maxLength' => 3000, 'minLength' => 1],
+ 'DocId' => ['title' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错', 'description' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错', 'type' => 'string', 'required' => false, 'example' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错'],
+ 'Title' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'required' => false, 'example' => '文档标题', 'maxLength' => 100],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
+ 'maxItems' => 10000,
+ 'minItems' => 2,
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'TopicCount',
'in' => 'formData',
- 'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6d3c0bc9-7561-41a4-be4c-d906abdb40a9',
- ],
+ 'schema' => ['title' => '最大聚合总数', 'description' => '最大聚合总数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '15'],
+ ],
+ [
+ 'name' => 'TitleLength',
+ 'in' => 'formData',
+ 'schema' => ['title' => '生成聚类的标题字数限制', 'description' => '生成聚类的标题字数限制', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '200', 'example' => '69'],
+ ],
+ [
+ 'name' => 'SummaryLength',
+ 'in' => 'formData',
+ 'schema' => ['title' => '生成聚类的摘要字数限制', 'description' => '生成聚类的摘要字数限制', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '500', 'example' => '49'],
],
],
'responses' => [
200 => [
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'a2267372-6042-46a4-aab0-1670dfc38c94',
- ],
- 'Input' => [
- 'title' => '用户的问题',
- 'description' => '用户的问题',
- 'type' => 'string',
- 'example' => '北京2025年新能源汽车发展趋势',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'in_progress' => '运行中',
- 'queued' => '排队中',
- 'cancelled' => '已取消',
- 'completed' => '已完成',
- 'failed' => '失败',
- ],
- 'example' => 'queued',
- ],
+ 'TaskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交内容聚合任务',
+ 'summary' => '提交内容聚合任务。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"a2267372-6042-46a4-aab0-1670dfc38c94\\",\\n \\"Input\\": \\"北京2025年新能源汽车发展趋势\\",\\n \\"Status\\": \\"queued\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询深度写作任务',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitDocClusterTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetDeepWriteTaskResult' => [
- 'summary' => '查询深度写作任务的结果。'."\n"
- .'如果指定任务没有执行完成(排队、执行中、失败、取消等),会返回当前执行状态。如果指定任务已完成,会以URL的形式返回该任务的产出物的压缩包,供用户下载查看。',
+ 'SubmitEnterpriseVocAnalysisTask' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -45567,237 +26844,166 @@
],
'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-1setzb9xb8m11vrc',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'FileKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '文件FileKey', 'description' => '文件FileKey', 'type' => 'string', 'required' => false, 'example' => 'oss://default/bucket-name/materialDocument/tenant_agent/fileName'],
+ ],
+ [
+ 'name' => 'MaterialType',
+ 'in' => 'formData',
+ 'schema' => ['title' => '素材类型(shortContent: 长短评论、或工单,dialogue: 对话)', 'description' => '素材类型(shortContent:长短评论、或工单,dialogue:对话)', 'type' => 'string', 'required' => false, 'example' => 'shortContent'],
+ ],
+ [
+ 'name' => 'ModelId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'string', 'required' => true, 'example' => 'qwen-max'],
+ ],
+ [
+ 'name' => 'ContentTags',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xbabac91-fdad-44d6-95ce-******',
+ 'title' => '内容标签',
+ 'description' => '内容标签',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '内容标签对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '一级标签-二级标签'],
+ 'TagValueDefinePrompt' => ['title' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)', 'description' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)', 'type' => 'string', 'required' => false, 'example' => '是,否'],
+ 'TagDefinePrompt' => ['title' => '标签定义', 'description' => '标签定义', 'type' => 'string', 'required' => false, 'example' => '一级标签-二级标签'],
+ 'TagTaskType' => ['title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview, 筛选:filter))', 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview,筛选:filter)', 'type' => 'string', 'required' => false, 'example' => 'singleTagValue'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'FilterTags',
+ 'in' => 'formData',
+ 'style' => 'json',
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'f8707efa-c30e-407f-a611-50871aa68952',
- ],
- 'ArtifactUrl' => [
- 'title' => '任务结果下载地址',
- 'description' => '任务结果下载地址',
- 'type' => 'string',
- 'example' => 'https://aimiaobi-service-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/aimiaobi/deep-write-workspace/142***1/dbaaebd1-eb1b-41e8-9b99-******-result.zip?Expire=1111',
- ],
- ],
+ 'title' => '过滤标签',
+ 'description' => '过滤标签列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '过滤标签对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagName' => ['title' => '标签名称', 'description' => '标签名称', 'type' => 'string', 'required' => false, 'example' => '一级标签-二级标签'],
+ 'TagValueDefinePrompt' => ['title' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)', 'description' => '标签值定义(如果是标签挖掘任务,则此Prompt是逗号分隔的枚举值、如果是总结概括人物则是总结概括的Prompt)', 'type' => 'string', 'required' => false, 'example' => '是,否'."\n"],
+ 'TagDefinePrompt' => ['title' => '标签定义', 'description' => '标签定义', 'type' => 'string', 'required' => false, 'example' => '一级标签-二级标签'],
+ 'TagType' => ['title' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview, 筛选:filter))', 'description' => '标签挖掘任务类型(单标签:singleTagValue,多标签:multiTagValues,总结概括:summaryAndOverview,筛选:filter)', 'type' => 'string', 'required' => false, 'example' => 'singleTagValue'],
],
+ 'required' => false,
],
+ 'required' => false,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"f8707efa-c30e-407f-a611-50871aa68952\\",\\n \\"ArtifactUrl\\": \\"https://aimiaobi-service-pre-hangzhou.oss-cn-hangzhou.aliyuncs.com/aimiaobi/deep-write-workspace/142***1/dbaaebd1-eb1b-41e8-9b99-******-result.zip?Expire=1111\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询深度写作任务的结果',
- ],
- 'CancelDeepWriteTask' => [
- 'summary' => '取消深度写作任务。',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
[
- 'AK' => [],
+ 'name' => 'PositiveSample',
+ 'in' => 'formData',
+ 'schema' => ['title' => '正面样本内容', 'description' => '正面样本内容', 'type' => 'string', 'required' => false, 'example' => '正面样本'],
],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
- 'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'PositiveSampleFileKey',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xxxxx',
- ],
+ 'schema' => ['title' => '正面样本文件FileKey', 'description' => '正面样本文件FileKey', 'type' => 'string', 'required' => false, 'example' => 'oss://default/bucket-name/path/xxx.xlsx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'TaskType',
'in' => 'formData',
+ 'schema' => ['title' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)', 'description' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)', 'type' => 'string', 'required' => false, 'example' => 'lightAppSass'],
+ ],
+ [
+ 'name' => 'Contents',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
+ 'title' => '待挖掘的素材内容列表',
+ 'description' => '待挖掘的素材内容列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '待挖掘的素材内容对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '待挖掘的素材', 'description' => '待挖掘的素材', 'type' => 'string', 'required' => false, 'example' => '内容文本'],
+ 'ExtraInfo' => ['title' => '额外补充信息,直接给到大模型', 'description' => '额外补充信息,直接给到大模型', 'type' => 'string', 'required' => false, 'example' => '额外信息'],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'xbabac91-fdad-44d6-95ce-******',
],
],
+ [
+ 'name' => 'ApiKey',
+ 'in' => 'formData',
+ 'schema' => ['title' => '百炼APIKEY', '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-sdfs2-wewerwe-ere'],
+ ],
],
'responses' => [
200 => [
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
+ 'title' => '模板校验结果',
+ 'description' => '模板校验结果',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'xbabac91-fdad-44d6-95ce-******',
- ],
- 'Input' => [
- 'title' => '用户的问题',
- 'description' => '用户的问题',
- 'type' => 'string',
- 'example' => '北京2025年新能源汽车发展趋势',
- ],
- 'Status' => [
- 'title' => '任务状态',
- 'description' => '任务状态',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'in_progress' => '运行中',
- 'queued' => '排队中',
- 'cancelled' => '已取消',
- 'completed' => '已完成',
- 'failed' => '失败',
- ],
- 'example' => 'cancelled',
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xxxxx'],
],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交企业VOC分析任务',
+ 'summary' => '提交VOC异步任务。',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-17T12:39:56.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xbabac91-fdad-44d6-95ce-******\\",\\n \\"Input\\": \\"北京2025年新能源汽车发展趋势\\",\\n \\"Status\\": \\"cancelled\\"\\n }\\n}","type":"json"}]',
- 'title' => '取消深度写作任务',
- ],
- 'RunDeepWriting' => [
- 'summary' => '查询深度写作事件。'."\n"
- .'系统以SSE事件的形式下发任务执行过程中的详细信息。',
- 'path' => '/pop/deepWrite/runDeepWriting',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxxx\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SubmitExportTermsTask' => [
+ 'summary' => '导出词库任务',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -45805,42 +27011,17 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-ir8zkqry2fncaxwq',
- ],
- ],
- [
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '95c2fbe6-5a20-4fc2-8a93-376ed05fbe13',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Cursor',
+ 'name' => 'TermsName',
'in' => 'formData',
- 'schema' => [
- 'description' => '游标。流式事件的序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '词典名称。可选。不填默认 Default', 'description' => '词典名称。可选。不填默认 Default', 'type' => 'string', 'required' => false],
],
],
'responses' => [
@@ -45850,258 +27031,68 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'Event' => [
- 'description' => 'SSE事件。',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'response.sub_task.created' => '子任务已创建',
- 'response.output_item.done' => '中间结果输出完成',
- 'response.completed' => '任务完成',
- 'response.created' => '任务已创建',
- ],
- 'example' => 'response.output_item.done',
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => 'c2e2e991-f96a-4fcc-9ff7-d0df46c6d232',
- ],
- 'StatusCode' => [
- 'description' => 'http响应码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'b84d31a5-44b2-4a35-9c6d-878d459c93d0',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => 'FAB10D42-F081-557B-8DCB-D6FB7AAF100B',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => [
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => '类型',
- 'type' => 'string',
- 'example' => '同上级Event',
- ],
- 'SequenceNumber' => [
- 'description' => '流式事件的序号',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'OutputIndex' => [
- 'description' => '本次事件新加的输出item的序号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Response' => [
- 'description' => '响应体',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => '本次任务的唯一标识',
- 'type' => 'string',
- 'example' => 'b2dc224b38694e0b668020159a7c5732',
- ],
- 'Status' => [
- 'description' => '本次任务的执行状态',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'in_progress' => '处理中',
- 'completed' => '已完成',
- ],
- 'example' => 'in_progress',
- ],
- ],
- ],
- 'Item' => [
- 'description' => '本次事件新加的输出item',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'description' => 'item的唯一标识',
- 'type' => 'string',
- 'example' => '88f6ed9e85c4f9377378da23e6a370d1',
- ],
- 'Status' => [
- 'description' => 'item的状态',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'in_progress' => 'in_progress',
- 'completed' => 'completed',
- ],
- 'example' => 'completed',
- ],
- 'Type' => [
- 'description' => 'item的类型',
- 'type' => 'string',
- 'enumValueTitles' => [
- 'function_call' => 'function_call',
- 'message' => 'message',
- ],
- 'example' => 'function_call',
- ],
- 'Arguments' => [
- 'description' => '参数',
- 'type' => 'string',
- 'example' => 'item类型为function_call时,此字段有值,为调用函数的入参',
- ],
- 'Name' => [
- 'description' => '参数名称',
- 'type' => 'string',
- 'example' => 'item类型为function_call时,此字段有值,为调用的函数名字',
- ],
- 'Result' => [
- 'description' => 'item的结果',
- 'type' => 'string',
- 'example' => 'item类型为function_call时,此字段有值,为调用的函数的输出',
- ],
- 'Agent' => [
- 'description' => '输出此item的agent名字',
- 'type' => 'string',
- 'example' => 'ProjectManager',
- ],
- 'Content' => [
- 'description' => 'item类型为message时,此字段有值,是输出content的列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文本内容',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'description' => 'item类型为message时,此字段的值是output_text',
- 'type' => 'string',
- 'example' => 'output_text',
- ],
- 'Text' => [
- 'description' => 'item类型为message时, 输出的文本内容',
- 'type' => 'string',
- 'example' => '<TASK_DONE>',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'RequestId' => [
- 'description' => '唯一请求ID',
- 'type' => 'string',
- 'example' => '31AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3',
- ],
- 'HttpStatusCode' => [
- 'description' => 'Http状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => ' 提交导出词库任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitExportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"错误消息\\",\\n \\"Event\\": \\"response.output_item.done\\",\\n \\"SessionId\\": \\"c2e2e991-f96a-4fcc-9ff7-d0df46c6d232\\",\\n \\"StatusCode\\": 200,\\n \\"TaskId\\": \\"b84d31a5-44b2-4a35-9c6d-878d459c93d0\\",\\n \\"TraceId\\": \\"FAB10D42-F081-557B-8DCB-D6FB7AAF100B\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Type\\": \\"同上级Event\\",\\n \\"SequenceNumber\\": \\"1\\",\\n \\"OutputIndex\\": 1,\\n \\"Response\\": {\\n \\"Id\\": \\"b2dc224b38694e0b668020159a7c5732\\",\\n \\"Status\\": \\"in_progress\\"\\n },\\n \\"Item\\": {\\n \\"Id\\": \\"88f6ed9e85c4f9377378da23e6a370d1\\",\\n \\"Status\\": \\"completed\\",\\n \\"Type\\": \\"function_call\\",\\n \\"Arguments\\": \\"item类型为function_call时,此字段有值,为调用函数的入参\\",\\n \\"Name\\": \\"item类型为function_call时,此字段有值,为调用的函数名字\\",\\n \\"Result\\": \\"item类型为function_call时,此字段有值,为调用的函数的输出\\",\\n \\"Agent\\": \\"ProjectManager\\",\\n \\"Content\\": [\\n {\\n \\"Type\\": \\"output_text\\",\\n \\"Text\\": \\"<TASK_DONE>\\"\\n }\\n ]\\n }\\n }\\n },\\n \\"RequestId\\": \\"31AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"successful\\",\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '查询深度写作事件',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
],
- 'GetPptArtifact' => [
- 'summary' => '查询PPT作品信息',
+ 'SubmitFactAuditUrl' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '业务空间ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-az2gglxxxx',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'PptArtifactId',
+ 'name' => 'Url',
'in' => 'formData',
- 'schema' => [
- 'title' => '作品ID',
- 'description' => 'PPT作品ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '5232136',
- ],
+ 'schema' => ['title' => '用户希望使用的审核信息来源 URL。通过该接口新增信源 URL 后,事实性审核的信息来源会只从配置好的 URL 列表中获取;如果不新增 URL,则默认从全网检索审核所需的信息。每位用户最多可以配置 10 条信源 URL。', 'description' => '用户希望使用的审核信息来源 URL。通过该接口新增信源 URL 后,事实性审核的信息来源会只从配置好的 URL 列表中获取;如果不新增 URL,则默认从全网检索审核所需的信息。每位用户最多可以配置 10 条信源 URL。', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com'],
],
],
'responses' => [
@@ -46111,372 +27102,138 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
- 'type' => 'object',
- 'properties' => [
- 'CreateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2024-11-25 11:40:50',
- ],
- 'Id' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '内容标题'."\n"
- ."\n",
- ],
- 'UpdateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2024-11-25 11:40:50',
- ],
- 'FileKey' => [
- 'description' => '后端业务存储本次规则库解析结果的路径。',
- 'type' => 'string',
- 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx',
- ],
- 'FileAttr' => [
- 'description' => '文件属性',
- 'type' => 'object',
- 'properties' => [
- 'FileName' => [
- 'description' => '文件名称',
- 'type' => 'string',
- 'example' => 'xxx.pptx',
- ],
- 'Width' => [
- 'description' => '宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '800',
- ],
- 'TmpUrl' => [
- 'description' => '视频文件临时访问URL。1小时过期',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.pptx',
- ],
- 'Height' => [
- 'description' => '高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '600',
- ],
- ],
- ],
- ],
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Data' => ['title' => '新增 URL 的成功提示。', 'description' => '新增 URL 的成功提示。', 'type' => 'string', 'example' => 'SUCCESSED'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交事实性审核 URL',
+ 'summary' => '妙笔为您提供了新的事实性审核能力,在联网搜索并判断正误的前提下,还支持用户自定义配置搜索来源 URL。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"CreateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"Id\\": 10,\\n \\"Title\\": \\"内容标题\\\\n\\\\n\\",\\n \\"UpdateTime\\": \\"2024-11-25 11:40:50\\",\\n \\"FileKey\\": \\"oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"xxx.pptx\\",\\n \\"Width\\": 800,\\n \\"TmpUrl\\": \\"http://www.example.com/xxx.pptx\\",\\n \\"Height\\": 600\\n }\\n }\\n}","type":"json"}]',
- 'title' => '查询PPT作品信息',
- 'description' => '接入说明:'."\n"
- ."\n"
- .'- 当前接口为 HTTP-SSE 协议。'."\n"
- .'- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持Java、Python版本的 sdk)请参考[PPT生成最佳实践文档](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices)。'."\n"
- .'- 其中获取 Java 异步 SDK 的最新版本: [请点击链接获取](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?spm=a2c4g.11186623.0.0.4cd3170d7rccDC&version=2023-08-01&language=java-async-tea&tab=primer-doc)。',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitFactAuditUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"SUCCESSED\\"\\n}","type":"json"}]',
],
- 'ListPptArtifacts' => [
- 'summary' => '查询PPT作品列表',
+ 'SubmitImportTermsTask' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '业务空间ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-az2xxxx',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'NextToken',
+ 'name' => 'FileKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '下一页的token',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'cEoBWREAXdxaOyjq/cqAbg==',
- ],
+ 'schema' => ['title' => '文件FileKey', 'description' => '文件FileKey', 'type' => 'string', 'required' => true, 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'],
],
[
- 'name' => 'Query',
+ 'name' => 'TermsName',
'in' => 'formData',
- 'schema' => [
- 'description' => '搜索关键词:作品名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '数字时代的营销策划与文案创作',
- ],
- ],
- [
- 'name' => 'MaxResults',
- 'in' => 'query',
- 'schema' => [
- 'description' => '本次请求期望查询的数据条目(废弃)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0',
- ],
+ 'schema' => ['title' => '词典名称。可选。不填默认 Default', 'description' => '词典名称。可选。不填默认 Default', 'type' => 'string', 'required' => false],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => '响应结果',
- 'description' => '响应结果',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
- 'Current' => [
- 'description' => '当前页。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'Data' => [
- 'description' => '是否删除成功',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'CreateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2024-01-04 11:46:07',
- ],
- 'Id' => [
- 'title' => '文档唯一标识',
- 'description' => '文档唯一标识',
- 'type' => 'integer',
- 'format' => 'int64',
- 'example' => '10',
- ],
- 'Title' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'example' => '作品标题',
- ],
- 'UpdateTime' => [
- 'title' => '更新日期',
- 'description' => '更新日期',
- 'type' => 'string',
- 'example' => '2025-04-14 19:59:53',
- ],
- 'FileKey' => [
- 'description' => '作品文件预览图',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.jpg',
- ],
- 'FileAttr' => [
- 'description' => '作品文件属性',
- 'type' => 'object',
- 'properties' => [
- 'FileName' => [
- 'description' => '文件名',
- 'type' => 'string',
- 'example' => '数字时代的营销策划与文案创作',
- ],
- 'Width' => [
- 'description' => '视频宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'TmpUrl' => [
- 'description' => '作品文件预览图',
- 'type' => 'string',
- 'example' => 'http://www.example.com/xxx.jpg',
- ],
- 'Height' => [
- 'description' => '高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '500',
- ],
- ],
- ],
- ],
+ 'title' => '业务数据',
+ 'description' => '业务数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- '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',
- ],
- 'Size' => [
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Success' => [
- 'title' => '是否成功:true 成功,false 失败',
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'NextToken' => [
- 'description' => '下一页的Token',
- 'type' => 'string',
- 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='."\n",
- ],
- 'MaxResults' => [
- 'description' => '本次返回的数据条目',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
],
],
],
],
- 'errorCodes' => [],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交导入词库任务',
+ 'summary' => '提交导入自定义词库任务',
+ 'requestParamsDescription' => '<notice>FileKey 生成方式见 [通用接口-文件上传下载GenerateUploadConfig - 生成上传配置](https://help.aliyun.com/zh/model-studio/api-aimiaobi-2023-08-01-generateuploadconfig)</notice>',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Current\\": 1,\\n \\"Data\\": [\\n {\\n \\"CreateTime\\": \\"2024-01-04 11:46:07\\",\\n \\"Id\\": 10,\\n \\"Title\\": \\"作品标题\\",\\n \\"UpdateTime\\": \\"2025-04-14 19:59:53\\",\\n \\"FileKey\\": \\"http://www.example.com/xxx.jpg\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"数字时代的营销策划与文案创作\\",\\n \\"Width\\": 100,\\n \\"TmpUrl\\": \\"http://www.example.com/xxx.jpg\\",\\n \\"Height\\": 500\\n }\\n }\\n ],\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Size\\": 10,\\n \\"Success\\": true,\\n \\"Total\\": 100,\\n \\"NextToken\\": \\"cEoBWREAXdxaOyjq/cqAbg==\\\\n\\",\\n \\"MaxResults\\": 10\\n}","type":"json"}]',
- 'title' => '查询PPT作品列表',
- ],
- 'RunPptOutlineGeneration' => [
- 'summary' => '生成PPT大纲内容',
- 'path' => '/pop/ppt/runPptOutlineGeneration',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitImportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'SubmitParseDocumentLayoutTask' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-8v8a5mfpxffrj1pn',
- ],
+ 'schema' => ['title' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'],
],
[
- 'name' => 'Prompt',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '用户问题',
- 'description' => '用户问题',
- 'type' => 'string',
- 'required' => true,
- 'example' => '帮我生成一个消防安全主题的PPT',
- ],
+ 'name' => 'Content',
+ 'in' => 'query',
+ 'schema' => ['title' => '待排版内容', 'description' => '待排版内容', 'type' => 'string', 'required' => true, 'example' => '正文'],
],
],
'responses' => [
@@ -46486,126 +27243,35 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'Success',
- ],
- 'ErrorMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'xxx',
- ],
- 'Event' => [
- 'description' => 'SSE事件。task-started:开始,task-finished:结束,task-failed:失败',
- 'type' => 'string',
- 'example' => 'task-started',
- ],
- 'SessionId' => [
- 'description' => '会话ID。',
- 'type' => 'string',
- 'example' => '1a3d7c9f-3a6d-4e49-b176-2d8721a27397',
- ],
- 'StatusCode' => [
- 'description' => '状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '8996314ce5514867943c71935e6a45af',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '0bc1ec3a17435601877224179ecc8a',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Data' => [
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'description' => '输出内容',
- 'type' => 'string',
- 'example' => '文本生成结果',
- ],
- ],
- ],
+ 'TaskId' => ['description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
- 'RequestId' => [
- 'description' => '请求唯一标识',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Message' => [
- 'description' => '信息',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
- ],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交排版任务',
+ 'summary' => '提交版本任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"Success\\",\\n \\"ErrorMessage\\": \\"xxx\\",\\n \\"Event\\": \\"task-started\\",\\n \\"SessionId\\": \\"1a3d7c9f-3a6d-4e49-b176-2d8721a27397\\",\\n \\"StatusCode\\": 200,\\n \\"TaskId\\": \\"8996314ce5514867943c71935e6a45af\\",\\n \\"TraceId\\": \\"0bc1ec3a17435601877224179ecc8a\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"文本生成结果\\"\\n }\\n },\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '生成PPT大纲内容',
- 'description' => '接入说明:'."\n"
- ."\n"
- .'- 当前接口为 HTTP-SSE 协议。'."\n"
- .'- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持Java、Python版本的 sdk)请参考[PPT生成最佳实践文档](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices)。'."\n"
- .'- 其中获取 Java 异步 SDK 的最新版本: [请点击链接获取](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?spm=a2c4g.11186623.0.0.4cd3170d7rccDC&version=2023-08-01&language=java-async-tea&tab=primer-doc)。',
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
],
- 'InitiatePptCreation' => [
- 'summary' => '重要说明:这个接口涉及到扣费,请注意费用'."\n"
- ."\n"
- .'这个接口包含两个操作:'."\n"
- .'1. 下发用于初始化“PPT生成”的前端组件的code'."\n"
- .'2. 进行计费',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'SubmitSmartAudit' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -46613,54 +27279,79 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
+ 'schema' => ['title' => '业务空间ID', 'description' => '[业务空间ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ [
+ 'name' => 'Text',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待审核的内容', 'description' => '待审核的内容', 'type' => 'string', 'required' => false, 'example' => '“你好呀”'],
+ ],
+ [
+ 'name' => 'SubCodes',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
+ 'description' => '子审核编码列表',
+ 'type' => 'array',
+ 'items' => ['title' => 'ImageAudit表示图片审核', 'description' => '子审核编码,子审核编码详见接口 [ListAuditContentErrorTypes](~~2929521~~)或下述参数补充说明', 'type' => 'string', 'required' => false, 'example' => 'PunctuationError'],
'required' => false,
- 'example' => 'llm-3fy94b2rtadt01qa',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'imageUrls',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '指令',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '95c2fbe6-5a20-4fc2-8a93-376ed05fbe13',
+ 'title' => '图片审核时传递的参数',
+ 'description' => '图片审核时传递的参数(已弃用,请使用ImageUrlList)',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '图片审核时传递的参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'url' => ['title' => 'Url可能是链接,可能是base64', 'description' => 'Url可能是链接,可能是base64', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/xxx.jpg'],
+ 'id' => ['title' => '图片唯一标识ID', 'description' => '图片唯一标识ID', 'type' => 'string', 'required' => false, 'example' => '3HAZTv62M0vkyz5B'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'Outline',
+ 'name' => 'ImageUrlList',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '大纲',
- 'type' => 'string',
+ 'title' => '图片审核时传递的参数',
+ 'description' => '图片审核时传递的参数',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => 'Url可能是链接,可能是base64', 'description' => 'Url可能是链接,可能是base64', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxx.png'],
+ 'Id' => ['title' => '图片唯一标识ID', 'description' => '图片唯一标识ID', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
'required' => false,
- 'example' => '# 中国传统文化艺术的魅力'."\n"
- ."\n"
- .'## 1. 传统文化艺术的源远流长'."\n"
- ."\n"
- .'### 1.1 中国古代艺术发展历程'."\n"
- ."\n"
- .'#### 1.1.1 古代绘画艺术的演变'."\n"
- .'- 从新石器时代的彩陶绘画到东汉时期帛画的出现,绘画形式不断丰富,展现了古人对美的独特追求。唐代绘画风格多样,吴道子的《送子天王图》线条流畅,色彩绚丽,体现了唐代绘画的高超技艺。'."\n"
- ."\n"
- .'#### 1.1.2 书法艺术的传承与创新'."\n"
- .'- 书法从甲骨文到楷书、行书、草书,历经数千年演变,承载着中华文化的深厚内涵。王羲之的《兰亭序》被誉为“天下第一行书”,其笔法精妙,结构严谨,展现了书法艺术的巅峰。',
],
],
+ [
+ 'name' => 'NoteId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '基于规则库审校的规则库ID(默认 Default)', 'description' => '基于规则库审校的规则库ID(默认 Default)', 'type' => 'string', 'required' => false, 'example' => 'note_1_486'],
+ ],
+ [
+ 'name' => 'TermsName',
+ 'in' => 'formData',
+ 'schema' => ['title' => '基于词库审校的词库名称(默认 Default)', 'description' => '基于词库审校的词库名称(默认 Default)', 'type' => 'string', 'required' => false, 'example' => 'Default'],
+ ],
],
'responses' => [
200 => [
@@ -46669,523 +27360,759 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '11AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'],
+ 'Success' => ['title' => '此次请求是否成功', 'description' => '此次请求是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '错误码', 'description' => '错误码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Message' => ['title' => '错误消息', 'description' => '错误消息', 'type' => 'string', 'example' => '错误消息'],
+ 'HttpStatusCode' => ['title' => 'http错误码', 'description' => 'http错误码', 'type' => 'integer', 'format' => 'int32', 'example' => '400'],
'Data' => [
- 'title' => '',
- 'description' => '返回数据',
+ 'title' => '任务响应对象',
+ 'description' => '任务响应对象',
'type' => 'object',
'properties' => [
- 'AppKey' => [
- 'title' => 'AppKey',
- 'description' => 'AppKey',
- 'type' => 'string',
- 'example' => 'S1X5ecouBztZelaQ',
- ],
- 'Code' => [
- 'title' => 'Code',
- 'description' => 'Code',
- 'type' => 'string',
- 'example' => '7dhqd2',
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xxxx'],
],
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交智能审校任务',
+ 'summary' => '提交智能审核',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](~~3000990~~)'."\n"
+ ."\n"
+ .'# 支持的审核类型'."\n"
+ ."\n"
+ .'## 审校大类概览'."\n"
+ ."\n"
+ .'| 审校大类 | 说明 |'."\n"
+ .'| -------- | -------- |'."\n"
+ .'| 内容准确性 | 音/形相似差错;标点符号错误;的地得错误;用词不当/语法错误;人名错误;地名错误;引用错误;专有名称/术语错误 |'."\n"
+ .'| 格式规范问题 | 大小写不规范;数字错误;计量单位不规范;繁体字 |'."\n"
+ .'| 内容结构问题 | 文字冗余;片段重复;逻辑矛盾;占位符未填充 |'."\n"
+ .'| 政治性问题 | 敏感和内容导向风险;姓名或排序差错;固有表述差错;机构名称不规范;重要讲话引用差错;落马官员;姓名职务搭配错误;职务表述错误 |'."\n"
+ .'| 安全合规问题 | 暴恐;色情;违禁;侮辱;劣迹艺人;个人隐私;报道规范 |'."\n"
+ .'| 法律错误 | 法律法规引用;法律条文错误 |'."\n"
+ .'| 其他专业知识错误 | 违反广告法;金融类信息;科技名词 |'."\n"
+ .'| 事实性检查 | 事实性审核正确项/错误项 |'."\n"
+ .'| 图片审核 | 图片内容审核 |'."\n"
+ .'| 自定义词库 | 自定义词库审核 |'."\n"
+ .'| 规则库审核 | 规则库审核 |'."\n"
+ .'| 英文审校 | 术语标准化;动词时态准确性;标点与引号;拼写与语言变体;句子结构与清晰度;数字与百分比格式;规范用语 |'."\n"
+ ."\n"
+ .'---'."\n"
+ ."\n"
+ .'## 子审核编码取值列表'."\n"
+ ."\n"
+ .'### 1. 内容准确性'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 音/形相似差错 | PhoneticSimilarError |'."\n"
+ .'| 标点符号错误 | PunctuationError |'."\n"
+ .'| 的地得错误 | ParticleUsageError |'."\n"
+ .'| 用词不当/语法错误 | WordError |'."\n"
+ .'| 人名错误 | PersonNameError |'."\n"
+ .'| 地名错误 | LocationError |'."\n"
+ .'| 引用错误 | ReferenceError |'."\n"
+ .'| 专有名称/术语错误 | NounItemError |'."\n"
+ ."\n"
+ .'### 2. 格式规范问题'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 大小写不规范 | CapitalizationError |'."\n"
+ .'| 数字错误 | NumberError |'."\n"
+ .'| 计量单位不规范 | UnitError |'."\n"
+ .'| 繁体字 | TraditionalChineseError |'."\n"
+ ."\n"
+ .'### 3. 内容结构问题'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 文字冗余 | WordRedundancy |'."\n"
+ .'| 片段重复 | DuplicateError |'."\n"
+ .'| 逻辑矛盾 | LogicContradiction |'."\n"
+ .'| 占位符未填充 | PlaceholderNotFilled |'."\n"
+ ."\n"
+ .'### 4. 政治性问题'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 敏感和内容导向风险 | SensitiveContentRisk |'."\n"
+ .'| 姓名或排序差错 | NameOrderError |'."\n"
+ .'| 固有表述差错 | ConventionalExpressionError |'."\n"
+ .'| 机构名称不规范 | DepartmentNameError |'."\n"
+ .'| 重要讲话引用差错 | ImportantSpeechError |'."\n"
+ .'| 落马官员 | FallenOfficialError |'."\n"
+ .'| 姓名职务搭配错误 | LeaderTitleMatchError |'."\n"
+ .'| 职务表述错误 | TitleError |'."\n"
+ ."\n"
+ .'### 5. 安全合规问题'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 暴恐 | ViolenceTerrorismError |'."\n"
+ .'| 色情 | PornographyError |'."\n"
+ .'| 违禁 | ProhibitedContentError |'."\n"
+ .'| 侮辱 | InsultError |'."\n"
+ .'| 劣迹艺人 | DisgracedArtistError |'."\n"
+ .'| 个人隐私 | PersonalPrivacyError |'."\n"
+ .'| 报道规范 | ReportingStandardError |'."\n"
+ ."\n"
+ .'### 6. 法律错误'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 法律法规引用 | LegalReferenceError |'."\n"
+ .'| 法律条文错误 | LegalProvisionsError |'."\n"
+ ."\n"
+ .'### 7. 其他专业知识错误'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 违反广告法 | AdvertisingProhibitedWordsError |'."\n"
+ .'| 金融类信息 | FinancialInformationError |'."\n"
+ .'| 科技名词 | TechnicalTermError |'."\n"
+ ."\n"
+ .'### 8. 事实性检查'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 事实性审核-正确项 | CorrectFact |'."\n"
+ .'| 事实性审核-错误项 | WrongFactError |'."\n"
+ ."\n"
+ .'### 9. 图片审核'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 图片审核 | ImageAudit |'."\n"
+ ."\n"
+ .'### 10. 自定义词库'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 自定义词库 | WordLibrary |'."\n"
+ ."\n"
+ .'### 11. 规则库审核'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 规则库审核 | WrongQuestionBook |'."\n"
+ ."\n"
+ .'### 12. 英文审校'."\n"
+ ."\n"
+ .'| 描述 | code |'."\n"
+ .'| ---- | ---- |'."\n"
+ .'| 术语标准化 | TerminologyNormalisation |'."\n"
+ .'| 动词时态准确性 | VerbTenseAccuracy |'."\n"
+ .'| 标点与引号 | PunctuationAndQuotationMarks |'."\n"
+ .'| 拼写与语言变体 | SpellingAndLanguageVariety |'."\n"
+ .'| 句子结构与清晰度 | SentenceStructureAndClarity |'."\n"
+ .'| 数字与百分比格式 | NumericAndPercentageStyle |'."\n"
+ .'| 其他规范用语 | Others |',
+ 'changeSet' => [
+ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-08-04T11:57:09.000Z', 'description' => '请求参数发生变更'],
+ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"11AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"AppKey\\": \\"S1X5ecouBztZelaQ\\",\\n \\"Code\\": \\"7dhqd2\\"\\n }\\n}","type":"json"}]',
- 'title' => '初始化用来创建PPT的会话',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitSmartAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxx\\"\\n }\\n}","type":"json"}]',
],
- 'GetPptConfig' => [
- 'summary' => '获取PPT组件配置',
+ 'SubmitSmartClipTask' => [
+ 'summary' => '提交一键成片剪辑任务。',
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-az2gglkjauwnnhpq',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => '业务空间ID'],
],
- ],
- 'responses' => [
- 200 => [
+ [
+ 'name' => 'InputConfig',
+ 'in' => 'formData',
+ 'style' => 'json',
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
+ 'VideoIds' => [
+ 'title' => '视频素材ID对象列表',
+ 'description' => '视频素材ID对象列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '素材ID对象',
+ 'description' => '素材ID对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => 'ID的类型:'."\n"
+ .'materialId: 妙笔素材库引用ID'."\n"
+ .'fileKey: 妙笔FileKey'."\n"
+ .'url: 可公开访问的URL', 'description' => 'ID的类型:'."\n"
+ .'materialId:妙笔素材库引用ID'."\n"
+ .'fileKey:妙笔FileKey'."\n"
+ .'url:可公开访问的URL', 'type' => 'string', 'required' => true, 'example' => 'fileKey'],
+ 'Id' => ['title' => '素材ID', 'description' => '素材ID', 'type' => 'string', 'required' => true, 'example' => 'oss://default/bucket-name/filepath/video.mp4'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
+ 'Titles' => [
+ 'title' => '标题列表',
+ 'description' => '标题列表',
+ 'type' => 'array',
+ 'items' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '视频标题'],
+ 'required' => false,
],
- 'Data' => [
- 'title' => '',
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'AppKey' => [
- 'title' => 'AppKey',
- 'description' => 'AppKey',
- 'type' => 'string',
- 'example' => '333444766',
+ 'BackgroundMusics' => [
+ 'title' => '背景音乐ID列表',
+ 'description' => '背景音乐ID列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '背景音乐ID对象',
+ 'description' => '背景音乐ID对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => 'ID的类型:'."\n"
+ .'materialId: 妙笔素材库引用ID'."\n"
+ .'fileKey: 妙笔FileKey'."\n"
+ .'url: 可公开访问的URL', 'description' => 'ID的类型:'."\n"
+ .'materialId:妙笔素材库引用ID'."\n"
+ .'fileKey:妙笔FileKey'."\n"
+ .'url:可公开访问的URL', 'type' => 'string', 'required' => true, 'example' => 'fileKey'],
+ 'Id' => ['title' => '背景音乐ID', 'description' => '背景音乐ID', 'type' => 'string', 'required' => true, 'example' => 'oss://default/bucket-name/filepath/video.mp3'],
],
- 'Code' => [
- 'title' => 'Code',
- 'description' => 'Code',
- 'type' => 'string',
- 'example' => 'r4wr5y6g',
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'Stickers' => [
+ 'title' => '贴纸列表',
+ 'description' => '贴纸列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '贴纸对象',
+ 'description' => '贴纸对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['title' => '贴纸左上角X坐标', 'description' => '贴纸左上角X坐标', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'],
+ 'Y' => ['title' => '贴纸左上角Y坐标', 'description' => '贴纸左上角Y坐标', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'],
+ 'Width' => ['title' => '贴纸宽度', 'description' => '贴纸宽度', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'],
+ 'Height' => ['title' => '贴纸高度', 'description' => '贴纸高度', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'],
+ 'StickerId' => [
+ 'title' => '贴纸ID',
+ 'description' => '贴纸ID',
+ 'type' => 'object',
+ 'properties' => [
+ 'Type' => ['title' => 'ID的类型:'."\n"
+ .'materialId: 妙笔素材库引用ID'."\n"
+ .'fileKey: 妙笔FileKey'."\n"
+ .'url: 可公开访问的URL', 'description' => 'ID的类型:'."\n"
+ .'materialId:妙笔素材库引用ID'."\n"
+ .'fileKey:妙笔FileKey'."\n"
+ .'url:可公开访问的URL', 'type' => 'string', 'required' => true, 'example' => 'fileKey'],
+ 'Id' => ['title' => '贴纸ID', 'description' => '贴纸ID', 'type' => 'string', 'required' => true, 'example' => 'oss://default/bucket-name/filepath/sticker.png'],
+ ],
+ 'required' => true,
+ ],
],
+ 'required' => false,
],
+ 'required' => false,
+ ],
+ 'SpeechTexts' => [
+ 'title' => '口播脚本文本列表',
+ 'description' => '口播脚本文本列表',
+ 'type' => 'array',
+ 'items' => ['title' => '语音识别文本', 'description' => '口播脚本文本', 'type' => 'string', 'required' => false, 'example' => '大家好,欢迎来到我的频道xxx'],
+ 'required' => false,
],
],
+ 'required' => true,
],
],
- ],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"AppKey\\": \\"333444766\\",\\n \\"Code\\": \\"r4wr5y6g\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取PPT组件配置',
- ],
- 'BindPptArtifact' => [
- 'summary' => '绑定PPT作品信息',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
- 'security' => [
- [
- 'AK' => [],
- ],
- ],
- 'operationType' => 'readAndWrite',
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
- 'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'OutputConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间ID',
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
+ 'title' => '输出配置',
+ 'description' => '输出配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'FileName' => ['title' => '输出文件名,必须包含{index}', 'description' => '输出文件名,必须包含{index}', 'type' => 'string', 'required' => false, 'example' => 'test_{index}.mp4', 'pattern' => '.*\\{index\\}.*'],
+ 'Width' => ['title' => '输出视频宽', 'description' => '输出视频宽', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1920'],
+ 'Height' => ['title' => '输出视频高', 'description' => '输出视频高', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1080'],
+ 'Count' => ['title' => '输出视频数量', 'description' => '输出视频数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'MaxDuration' => ['title' => '输出视频最大时长,单位:秒', 'description' => '输出视频最大时长,单位:秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120'],
+ 'SaveToGeneratedContent' => ['title' => '是否保存至内容管理', 'description' => '是否保存至内容管理', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
'required' => false,
- 'example' => 'llm-xgpt3m25qdosdjr3',
],
],
[
- 'name' => 'TaskId',
+ 'name' => 'EditingConfig',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => '85da2bfe-6f05-41af-9841-d73c5bbf43a2',
+ 'title' => '剪辑配置',
+ 'description' => '剪辑配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'TitleConfig' => [
+ 'title' => '标题配置',
+ 'description' => '标题配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['title' => '横幅文字左上角距离输出视频左上角的横向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。', 'description' => '横幅文字左上角距离输出视频左上角的横向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100'],
+ 'Y' => ['title' => '横幅文字左上角距离输出视频左上角的纵向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放', 'description' => '横幅文字左上角距离输出视频左上角的纵向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '100'],
+ 'TimelineIn' => ['title' => '标题出现的时间', 'description' => '标题出现的时间', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2'],
+ 'TimelineOut' => ['title' => '标题消失的时间', 'description' => '标题消失的时间', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '3'],
+ 'Alignment' => ['title' => 'TopLeft:视频左上角 '."\n"
+ .'TopCenter:视频竖直中轴线上侧 '."\n"
+ .'TopRight:视频右上角 '."\n"
+ .'CenterLeft:视频水平中轴线左侧 '."\n"
+ .'CenterCenter:视频中心位置 '."\n"
+ .'CenterRight:视频水平中轴线右侧 '."\n"
+ .'BottomLeft:视频左下角 '."\n"
+ .'BottomCenter:视频竖直中轴线下侧 '."\n"
+ .'BottomRight:视频右下角', 'description' => 'TopLeft:视频左上角 '."\n"
+ .'TopCenter:视频竖直中轴线上侧 '."\n"
+ .'TopRight:视频右上角 '."\n"
+ .'CenterLeft:视频水平中轴线左侧 '."\n"
+ .'CenterCenter:视频中心位置 '."\n"
+ .'CenterRight:视频水平中轴线右侧 '."\n"
+ .'BottomLeft:视频左下角 '."\n"
+ .'BottomCenter:视频竖直中轴线下侧 '."\n"
+ .'BottomRight:视频右下角', 'type' => 'string', 'required' => false, 'example' => 'TopLeft'],
+ ],
+ 'required' => false,
+ ],
+ 'MediaConfig' => [
+ 'title' => '媒体配置',
+ 'description' => '媒体配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Volume' => ['title' => '视频素材声音(0:静音)', 'description' => '视频素材声音(0:静音)', 'type' => 'number', 'format' => 'double', 'required' => false],
+ ],
+ 'required' => false,
+ ],
+ 'SpeechConfig' => [
+ 'title' => '口播配置',
+ 'description' => '口播配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Volume' => ['title' => '口播音频的音量,默认1。取值:[0, 10.0],支持小数,例:0.5。', 'description' => '口播音频的音量,默认1。取值:[0, 10.0],支持小数,例:0.5。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.5', 'default' => '1'],
+ 'Voice' => ['title' => '指定单个或多个口播音色(英文逗号分隔)。当指定多个voice时,会随机选取一个合成。音色的可选范围请参见[智能语音效果示例](https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example?spm=a2c4g.11186623.0.0.13091ee6Pw4Jqz)。例:"zhimiao_emo,zhilun"。', 'description' => '指定单个或多个口播音色(英文逗号分隔)。当指定多个voice时,会随机选取一个合成。音色的可选范围请参见[智能语音效果示例](https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example?spm=a2c4g.11186623.0.0.13091ee6Pw4Jqz)。例:"zhimiao_emo,zhilun"。', 'type' => 'string', 'required' => false],
+ 'Style' => ['title' => '口播声音风格,默认为空。若同时指定Voice和Style,则优先取用Voice'."\n"
+ .'"Gentle": 柔和'."\n"
+ .'"Serious":严肃'."\n"
+ .'"Entertainment":娱乐', 'description' => '口播声音风格,默认为空。若同时指定Voice和Style,则优先取用Voice'."\n"
+ .'"Gentle": 柔和'."\n"
+ .'"Serious":严肃'."\n"
+ .'"Entertainment":娱乐', 'type' => 'string', 'required' => false],
+ 'SpeechRate' => ['title' => '口播脚本语速'."\n"
+ .'语速,取值范围:-500~500,默认值:0。'."\n"
+ .'[-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]。'."\n"
+ ."\n"
+ .'计算方法如下:'."\n"
+ .'0.8倍速(1-1/0.8)/0.002 = -125'."\n"
+ .'1.2倍速(1-1/1.2)/0.001 = 166'."\n"
+ .'小于1倍速时,使用0.002系数。'."\n"
+ .'大于1倍速时,使用0.001系数。'."\n"
+ .'实际算法结果取近似值。', 'description' => '口播脚本语速'."\n"
+ .'语速,取值范围:-500~500,默认值:0。'."\n"
+ .'[-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]。'."\n"
+ ."\n"
+ .'计算方法如下:'."\n"
+ .'0.8倍速(1-1/0.8)/0.002 = -125'."\n"
+ .'1.2倍速(1-1/1.2)/0.001 = 166'."\n"
+ .'小于1倍速时,使用0.002系数。'."\n"
+ .'大于1倍速时,使用0.001系数。'."\n"
+ .'实际算法结果取近似值。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0', 'default' => '0'],
+ 'AsrConfig' => [
+ 'title' => '字幕参数配置',
+ 'description' => '字幕参数配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'X' => ['title' => '横幅文字左上角距离输出视频左上角的横向距离'."\n"
+ .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。', 'description' => '横幅文字左上角距离输出视频左上角的横向距离'."\n"
+ .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。', 'type' => 'number', 'format' => 'float', 'required' => false],
+ 'Y' => ['title' => '横幅文字左上角距离输出视频左上角的纵向距离'."\n"
+ .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。', 'description' => '横幅文字左上角距离输出视频左上角的纵向距离'."\n"
+ .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。', 'type' => 'number', 'format' => 'float', 'required' => false],
+ 'Alignment' => ['title' => '字幕对齐'."\n"
+ .'TopLeft:视频左上角'."\n"
+ .'TopCenter:视频竖直中轴线上侧'."\n"
+ .'TopRight:视频右上角'."\n"
+ .'CenterLeft:视频水平中轴线左侧'."\n"
+ .'CenterCenter:视频中心位置'."\n"
+ .'CenterRight:视频水平中轴线右侧'."\n"
+ .'BottomLeft:视频左下角'."\n"
+ .'BottomCenter:视频竖直中轴线下侧'."\n"
+ .'BottomRight:视频右下角', 'description' => '字幕对齐'."\n"
+ .'TopLeft:视频左上角'."\n"
+ .'TopCenter:视频竖直中轴线上侧'."\n"
+ .'TopRight:视频右上角'."\n"
+ .'CenterLeft:视频水平中轴线左侧'."\n"
+ .'CenterCenter:视频中心位置'."\n"
+ .'CenterRight:视频水平中轴线右侧'."\n"
+ .'BottomLeft:视频左下角'."\n"
+ .'BottomCenter:视频竖直中轴线下侧'."\n"
+ .'BottomRight:视频右下角', 'type' => 'string', 'required' => false],
+ 'Font' => ['title' => '字幕文字的字体。具体支持的字体参见字体列表。默认为SimSun字体。', 'description' => '字幕文字的字体。具体支持的字体参见字体列表。默认为SimSun字体。', 'type' => 'string', 'required' => false, 'example' => 'SimSun', 'default' => 'SimSun'],
+ 'FontColor' => ['title' => '字幕文字的颜色,格式为#后跟16进制值。例如:#ffffff。', 'description' => '字幕文字的颜色,格式为#后跟16进制值。例如:#ffffff。', 'type' => 'string', 'required' => false, 'example' => '#ffffff', 'default' => '#ffffff'],
+ 'FontSize' => ['title' => '字幕文字的字号。该字号会根据素材尺寸和成片尺寸进行缩放。默认为0,最大支持设置到5000。'."\n", 'description' => '字幕文字的字号。该字号会根据素材尺寸和成片尺寸进行缩放。默认为0,最大支持设置到5000。'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'default' => '0'],
+ 'Spacing' => ['title' => '横幅文字字间距。单位:像素值', 'description' => '横幅文字字间距。单位:像素值', 'type' => 'string', 'required' => false, 'example' => '0'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'BackgroundMusicConfig' => [
+ 'title' => '背景音乐配置',
+ 'description' => '背景音乐配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Volume' => ['title' => '背景音乐的音量,取值:[0, 10.0]', 'description' => '背景音乐的音量,取值:[0, 10.0]', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.2', 'default' => '0.2'],
+ 'Style' => ['title' => '背景音乐风格,默认为空,若InputConfig中已配置背景音乐,此字段不生效'."\n"
+ .'取值如下:'."\n"
+ .'"bgm-beauty":时尚'."\n"
+ .'"bgm-chinese-style":中国风'."\n"
+ .'"bgm-cuisine":美食'."\n"
+ .'"bgm-dynamic":动感'."\n"
+ .'"bgm-quirky":怪诞'."\n"
+ .'"bgm-relaxing":轻松'."\n"
+ .'"bgm-romantic":浪漫'."\n"
+ .'"bgm-upbeat":欢快', 'description' => '背景音乐风格,默认为空,若InputConfig中已配置背景音乐,此字段不生效'."\n"
+ .'取值如下:'."\n"
+ .'"bgm-beauty":时尚'."\n"
+ .'"bgm-chinese-style":中国风'."\n"
+ .'"bgm-cuisine":美食'."\n"
+ .'"bgm-dynamic":动感'."\n"
+ .'"bgm-quirky":怪诞'."\n"
+ .'"bgm-relaxing":轻松'."\n"
+ .'"bgm-romantic":浪漫'."\n"
+ .'"bgm-upbeat":欢快', 'type' => 'string', 'required' => false],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
],
],
[
- 'name' => 'ArtifactId',
+ 'name' => 'ExtendParam',
'in' => 'formData',
- 'schema' => [
- 'title' => '作品ID',
- 'description' => '作品ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '12342',
- ],
+ 'schema' => ['title' => '其他扩展参数(会与inputConfig、outputConfig、editingConfig合并)', 'description' => '其他扩展参数(会与inputConfig、outputConfig、editingConfig合并)', 'type' => 'string', 'required' => false],
],
],
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '任务响应对象',
- 'description' => '任务响应对象',
+ 'title' => '任务提交结果',
+ 'description' => '任务提交结果',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '110f8401-e5ba-42db-addb-4f70196000c1',
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交智能一键成片任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-01-02T11:56:41.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"TaskId\\": \\"110f8401-e5ba-42db-addb-4f70196000c1\\"\\n }\\n}","type":"json"}]',
- 'title' => '绑定PPT作品信息',
- ],
- 'DeletePptArtifact' => [
- 'summary' => '删除PPT作品',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitSmartClipTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SubmitTopicSelectionPerspectiveAnalysisTask' => [
+ 'summary' => '提交选题热点分析任务。',
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'delete',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Documents',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '业务空间ID',
- 'description' => '业务空间ID',
- 'type' => 'string',
+ 'title' => '待分析的文档列表。(documents与topic二者至少传一个)',
+ 'description' => '待分析的文档列表。(documents与topic二者至少传一个)',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文档列表信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'Author' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'required' => false, 'example' => '作者', 'maxLength' => 100],
+ 'Comments' => [
+ 'title' => '评论列表',
+ 'description' => '内容列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '评论对象',
+ 'description' => '对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'Text' => ['title' => '评论文本', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '内容'],
+ 'Username' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => false, 'example' => '用户名'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => true, 'example' => '文章内容', 'maxLength' => 3000, 'minLength' => 30],
+ 'PubTime' => ['title' => '发布时间。格式:YYYY-MM-dd HH:mm:ss', 'description' => '发布时间。格式:YYYY-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2024-01-22 10:29:00', 'maxLength' => 19],
+ 'Source' => ['title' => '文章来源', 'description' => '文章来源', 'type' => 'string', 'required' => false, 'example' => '新浪', 'maxLength' => 40],
+ 'Summary' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'required' => false, 'example' => '文章摘要', 'maxLength' => 200],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '文章标题', 'maxLength' => 100],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx', 'maxLength' => 1024],
+ ],
+ 'required' => false,
+ ],
'required' => false,
- 'example' => 'llm-xx',
+ 'maxItems' => 30,
],
],
[
- 'name' => 'PptArtifactId',
+ 'name' => 'Topic',
+ 'in' => 'formData',
+ 'schema' => ['title' => '待分析的主题名(documents与topic二者至少传一个)', 'description' => '待分析的主题名(documents与topic二者至少传一个)', 'type' => 'string', 'required' => false, 'example' => '待分析的主题名(documents与topic二者至少传一个)', 'maxLength' => 1000],
+ ],
+ [
+ 'name' => 'PerspectiveTypes',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => 'PPT作品ID',
- 'description' => 'PPT作品ID',
- 'type' => 'string',
+ 'title' => '要分析的选题视角任务,默认为空,空表示分析所有任务。 (TopicSummary: 主题事件摘要, HotViewPoints: 热门视角选题, TimedViewPoints: 时效视角选题, WebReviewPoints: 网评视角选题, FreshViewPoints: 新颖视角选题)',
+ 'description' => '要分析的选题视角任务,默认为空,空表示分析所有任务。 (TopicSummary: 主题事件摘要, HotViewPoints: 热门视角选题, TimedViewPoints: 时效视角选题, WebReviewPoints: 网评视角选题, FreshViewPoints: 新颖视角选题)',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '要分析的选题视角任务',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'TopicSummary',
+ 'enum' => ['TopicSummary', 'HotViewPoints', 'TimedViewPoints', 'WebReviewPoints', 'FreshViewPoints'],
+ ],
'required' => false,
- 'example' => '53245',
+ 'example' => 'TimedViewPoints',
],
],
],
'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' => 'xxxxx',
- ],
- 'Success' => [
- 'title' => '此次请求是否成功',
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Code' => [
- 'title' => '错误码',
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'DataNotExists',
- ],
- 'Message' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误消息',
- ],
- 'HttpStatusCode' => [
- 'title' => 'http错误码',
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '任务响应对象',
- 'description' => '响应对象',
+ 'title' => '业务数据',
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'PptArtifactId' => [
- 'title' => '任务ID',
- 'description' => 'PPT作品ID',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5233498',
- ],
+ 'TaskId' => ['title' => '任务唯一ID', 'description' => '任务唯一ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'TaskName' => ['title' => '任务名称', 'description' => '任务名称', 'type' => 'string', 'example' => '任务名称'],
],
],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"PptArtifactId\\": 5233498\\n }\\n}","type":"json"}]',
- 'title' => '删除PPT作品',
- 'description' => '接入说明:'."\n"
- ."\n"
- .'- 当前接口为 HTTP-SSE 协议。'."\n"
- .'- 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例(支持Java、Python版本的 sdk)请参考[PPT生成最佳实践文档](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices)。'."\n"
- .'- 其中获取 Java 异步 SDK 的最新版本: [请点击链接获取](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?spm=a2c4g.11186623.0.0.4cd3170d7rccDC&version=2023-08-01&language=java-async-tea&tab=primer-doc)。',
- ],
- 'AsyncUploadTenderDoc' => [
- 'summary' => '上传招标书文件',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'title' => '提交选题热点分析任务',
+ 'changeSet' => [
+ ['createdAt' => '2024-10-12T07:31:26.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'SubmitVideoAudit' => [
+ 'path' => '/quanmiao/aimiaobi/pop/videoAudit/submitVideoAudit',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '[工作空间ID](~~2782167~~)。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-az2gglkjauwnnhpq',
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '业务空间ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'],
],
[
- 'name' => 'TenderDocName',
+ 'name' => 'FileKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '招标书名字',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tender.pdf',
- ],
+ 'schema' => ['title' => '文件Key', 'description' => '妙笔系统内部文件唯一标识(FileKey与Url二选一)', 'type' => 'string', 'required' => false, 'example' => 'oss://default/xxx/video/test.mp4'],
],
[
- 'name' => 'FileKey',
+ 'name' => 'Url',
'in' => 'formData',
- 'schema' => [
- 'description' => '文件osskey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/materialDocument/1601892701595700_10169811/208757545922605632_yst-test_9eb7d7e1deb543d88e2d6f1c9df456ef.docx',
- ],
+ 'schema' => ['title' => '视频URL', 'description' => '视频URL(FileKey与Url二选一)', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/video.mp4'],
+ ],
+ [
+ 'name' => 'SnapshotInterval',
+ 'in' => 'formData',
+ 'schema' => ['title' => '抽帧间隔', 'description' => '抽帧间隔', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1.0'],
+ ],
+ [
+ 'name' => 'Ext',
+ 'in' => 'formData',
+ 'schema' => ['title' => '扩展参数', 'description' => '扩展参数', 'type' => 'string', 'required' => false, 'example' => '{}'],
],
],
'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' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'RequestId' => ['title' => '请求ID', 'description' => '请求ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'HttpStatusCode' => ['title' => 'HTTP状态码', 'description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Code' => ['title' => '业务状态码', 'description' => '业务状态码', 'type' => 'string', 'example' => 'success'],
+ 'Message' => ['title' => '返回信息', 'description' => '返回信息', 'type' => 'string', 'example' => '任务提交成功'],
+ 'Success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
'Data' => [
- 'description' => '业务数据',
+ 'title' => '提交任务结果数据',
+ 'description' => '提交任务结果数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'TaskId' => ['title' => '任务ID', 'description' => '任务ID', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '提交视频审校任务',
+ 'summary' => '提交视频审校',
+ 'description' => '全妙产品支持 iframe 嵌入 具体请参考文档: [客户对接_全妙公有云iframe定制方案](https://alidocs.dingtalk.com/i/nodes/m9bN7RYPWdyrPBREcyM6jDQ2VZd1wyK0?cid=116617178%3A898142682&utm_source=im&utm_scene=team_space&iframeQuery=utm_medium%3Dim_card%26utm_source%3Dim&utm_medium=im_card&corpId=dingd8e1123006514592)',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitVideoAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
- 'title' => '招标文档解析',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Code\\": \\"success\\",\\n \\"Message\\": \\"任务提交成功\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\"\\n }\\n}","type":"json"}]',
],
- 'GetBiddingRemainLimitNum' => [
- 'summary' => '获得标书功能剩余额度',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateCustomText' => [
+ 'summary' => '更新自定义文本。',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -47193,880 +28120,804 @@
],
'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
+ ],
+ [
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '主键ID', 'description' => '主键ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '96'],
],
[
- 'name' => 'ApiName',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'description' => 'api名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'asyncUploadTenderDoc',
- ],
+ 'schema' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '标题'],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'required' => false, 'example' => '内容'],
+ ],
+ [
+ 'name' => 'CommodityCode',
+ 'in' => 'formData',
+ 'schema' => ['title' => '商品code', 'description' => '商品code', 'type' => 'string', 'required' => false, 'example' => '商品code'],
],
],
'responses' => [
200 => [
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'True',
- ],
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'RemainNum' => [
- 'description' => '剩余数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int64', 'example' => '48'],
+ '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'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新自定义文本',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
+ 'additionalActions' => [],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RemainNum\\": 1\\n }\\n}","type":"json"}]',
- 'title' => '获得标书写作剩余额度',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": 48,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'GetBiddingDocInfo' => [
- 'summary' => '获得标书写作结果接口',
+ 'UpdateDataset' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'DatasetId',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集id', 'description' => '数据集id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'DatasetDescription',
'in' => 'formData',
+ 'schema' => ['title' => '数据集描述', 'description' => '数据集描述', 'type' => 'string', 'required' => false, 'example' => '企业自定义数据集', 'maxLength' => 30, 'minLength' => 0],
+ ],
+ [
+ 'name' => 'SearchDatasetEnable',
+ 'in' => 'formData',
+ 'schema' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'],
+ ],
+ [
+ 'name' => 'DatasetConfig',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '任务ID',
- 'type' => 'string',
+ 'title' => '三方搜索数据集配置',
+ 'description' => '三方搜索数据集配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'SearchSourceConfigs' => [
+ 'title' => '三方搜索:api定义',
+ 'description' => '三方搜索:api定义',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'DemoQuery' => ['title' => '可以搜索到的关键词,用来验证是否可用', 'description' => '可以搜索到的关键词,用来验证是否可用', 'type' => 'string', 'required' => false, 'example' => '可以搜索到的关键词,用来验证是否可用'],
+ 'Size' => ['title' => '默认请求、响应数据条数限制', 'description' => '默认请求、响应数据条数限制', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'SearchSourceRequestConfig' => [
+ 'title' => 'api请求配置',
+ 'description' => 'api请求配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Url' => ['title' => 'api地址', 'description' => 'api地址', 'type' => 'string', 'required' => false, 'example' => 'api地址'],
+ 'Method' => ['title' => '请求方式', 'description' => '请求方式', 'type' => 'string', 'required' => false, 'example' => '请求方式'],
+ 'ConnectTimeout' => ['title' => '连接超时时间:单位毫秒', 'description' => '连接超时时间:单位毫秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
+ 'SocketTimeout' => ['title' => '读超时时间:单位毫秒', 'description' => '读超时时间:单位毫秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3000'],
+ 'Headers' => [
+ 'description' => 'http请求头',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => 'http请求头',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => '参数名称'],
+ 'ValueType' => ['title' => '参数值数据类型: 默认string', 'description' => '参数值数据类型:默认string', 'type' => 'string', 'required' => false, 'example' => '参数值数据类型:默认string'],
+ 'ValueFormat' => ['title' => 'valueType = time 时有效', 'description' => 'valueType = time 时有效', 'type' => 'string', 'required' => false, 'example' => 'valueType = time 时有效'],
+ 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '参数值'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'Params' => [
+ 'title' => '请求path参数',
+ 'description' => '请求path参数',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '请求path参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'Name' => ['title' => '参数名称', 'description' => '参数名称', 'type' => 'string', 'required' => false, 'example' => '参数名称'],
+ 'ValueType' => ['title' => '参数值数据类型: 默认string', 'description' => '参数值数据类型:默认string', 'type' => 'string', 'required' => false, 'example' => '参数值数据类型:默认string'],
+ 'ValueFormat' => ['title' => 'valueType = time 时有效', 'description' => 'valueType = time 时有效', 'type' => 'string', 'required' => false, 'example' => 'valueType = time 时有效'],
+ 'Value' => ['title' => '参数值', 'description' => '参数值', 'type' => 'string', 'required' => false, 'example' => '参数值'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'PathParamsEnable' => ['title' => '是否开启pathParam', 'description' => '是否开启pathParam', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'Body' => ['title' => '请求body', 'description' => '请求body', 'type' => 'string', 'required' => false, 'example' => '{}'],
+ ],
+ 'required' => false,
+ ],
+ 'SearchSourceResponseConfig' => [
+ 'title' => 'api响应配置',
+ 'description' => 'api响应配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'JqNodes' => [
+ 'title' => '节点配置',
+ 'description' => '节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['title' => '节点key', 'description' => '节点key', 'type' => 'string', 'required' => false, 'example' => '节点key'],
+ 'Type' => ['title' => '节点数据类型:string number list object base', 'description' => '节点数据类型:string number list object base', 'type' => 'string', 'required' => false, 'example' => '节点数据类型:string number list object base'],
+ 'Path' => ['title' => '节点路径', 'description' => '节点路径', 'type' => 'string', 'required' => false, 'example' => '节点路径'],
+ 'JqNodes' => [
+ 'title' => '子节点配置',
+ 'description' => '子节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '节点key', 'type' => 'string', 'required' => false, 'example' => 'title'],
+ 'Type' => ['description' => 'type类型', 'type' => 'string', 'required' => false, 'example' => 'string'],
+ 'Path' => ['description' => '节点路径', 'type' => 'string', 'required' => false, 'example' => '.title'],
+ 'JqNodes' => [
+ 'description' => '子节点配置',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '子节点配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'Key' => ['description' => '节点key', 'type' => 'string', 'required' => false, 'example' => 'title'],
+ 'Type' => ['description' => 'type类型', 'type' => 'string', 'required' => false, 'example' => 'string'],
+ 'Path' => ['description' => '节点路径', 'type' => 'string', 'required' => false, 'example' => '.title'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ ],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => false,
+ ],
+ 'SearchSourceConfig' => [
+ 'description' => '数据集配置项',
+ 'type' => 'object',
+ 'properties' => [
+ 'TagSearchEnable' => ['description' => '标签是否参与搜索:默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'TagGenerateEnable' => ['description' => '标签是否参与生成:默认true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'MetadataKeyValueSearchEnable' => ['description' => 'metadata-keyValue 部分是否参与搜索:默认 true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'MetadataKeyValueGenerateEnable' => ['description' => 'metadata-keyValue 部分是否参与生成:默认 true', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
],
],
+ [
+ 'name' => 'AccessLevel',
+ 'in' => 'formData',
+ 'schema' => ['type' => 'string', 'example' => 'private'],
+ ],
],
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '此次请求是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'Data' => [
+ 'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'Step' => [
- 'description' => '当前所处状态',
- 'type' => 'string',
- 'example' => 'analysis'."\n"
- .'writing',
- ],
- 'Status' => [
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '0-waiting、1-running、2-success、3-pause、4-fail'."\n",
- ],
- 'Content' => [
- 'description' => '标书内容',
- 'type' => 'string',
- 'example' => '文章内容',
- ],
- 'ContentType' => [
- 'description' => '文件类型。',
- 'type' => 'string',
- 'example' => 'outline'."\n"
- .'bidding',
- ],
- 'ContentFormat' => [
- 'description' => '格式',
- 'type' => 'string',
- 'example' => 'markdown'."\n"
- .'html',
- ],
- 'TenderDocUrl' => [
- 'description' => '招标书地址',
- 'type' => 'string',
- 'example' => 'http://xxx',
- ],
- 'TenderFileType' => [
- 'description' => '招标书文件类型',
- 'type' => 'string',
- 'example' => 'pdf'."\n"
- .'docx',
+ 'DatasetId' => ['title' => '数据集ID', 'description' => '数据集ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'CreateUser' => ['title' => '创建者', 'description' => '创建者', 'type' => 'string', 'example' => 'xxx'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-12 21:46:24'],
+ 'DatasetType' => ['title' => '数据集类型', 'description' => '数据集类型', 'type' => 'string', 'example' => 'CustomSemanticSearch'],
+ 'DatasetName' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'example' => 'xxx'],
+ 'DatasetDescription' => ['title' => '数据集显示名称', 'description' => '数据集显示名称', 'type' => 'string', 'example' => 'xxx'],
+ 'SearchDatasetEnable' => ['title' => '数据集搜索开关', 'description' => '数据集搜索开关', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'NewsArticleResults' => [
+ 'description' => '文章列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'Data' => [
+ 'description' => '文章列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文章',
+ 'type' => 'object',
+ 'properties' => [
+ 'PubTime' => ['title' => '发布时间', 'description' => '发布时间', 'type' => 'string', 'example' => '2024-11-12 15:12:14'],
+ 'Source' => ['title' => '来源', 'description' => '来源', 'type' => 'string', 'example' => '央视网'],
+ 'Title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '文章标题'],
+ 'Content' => ['title' => '内容', 'description' => '内容', 'type' => 'string', 'example' => '文章内容'],
+ 'Url' => ['title' => '文章URL', 'description' => '文章URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'],
+ 'Summary' => ['title' => '文章摘要', 'description' => '文章摘要', 'type' => 'string', 'example' => '文章摘要'],
+ ],
+ ],
+ ],
+ 'Current' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'Size' => ['title' => '每页记录条数', 'description' => '每页记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'Total' => ['title' => '总记录条数', 'description' => '总记录条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ ],
+ ],
],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-修改',
+ 'summary' => '数据源管理-更新。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Step\\": \\"analysis\\\\nwriting\\",\\n \\"Status\\": 0,\\n \\"Content\\": \\"文章内容\\",\\n \\"ContentType\\": \\"outline\\\\nbidding\\",\\n \\"ContentFormat\\": \\"markdown\\\\nhtml\\",\\n \\"TenderDocUrl\\": \\"http://xxx\\",\\n \\"TenderFileType\\": \\"pdf\\\\ndocx\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
- 'title' => '获得标书写作结果',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DatasetId\\": 1,\\n \\"CreateUser\\": \\"xxx\\",\\n \\"CreateTime\\": \\"2024-11-12 21:46:24\\",\\n \\"DatasetType\\": \\"CustomSemanticSearch\\",\\n \\"DatasetName\\": \\"xxx\\",\\n \\"DatasetDescription\\": \\"xxx\\",\\n \\"SearchDatasetEnable\\": 1,\\n \\"NewsArticleResults\\": [\\n {\\n \\"Data\\": [\\n {\\n \\"PubTime\\": \\"2024-11-12 15:12:14\\",\\n \\"Source\\": \\"央视网\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"Content\\": \\"文章内容\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\",\\n \\"Summary\\": \\"文章摘要\\"\\n }\\n ],\\n \\"Current\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 100,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'EditBiddingDoc' => [
- 'summary' => '编辑标书内容接口',
+ 'UpdateDatasetDocument' => [
'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'update',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
],
[
- 'name' => 'TaskId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0dbf1055f8a2475d99904c3b76a0ffba',
- ],
- ],
- [
- 'name' => 'Content',
+ 'name' => 'Document',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '文本内容',
- 'type' => 'string',
- 'required' => false,
- 'example' => '标书内容',
+ 'title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)',
+ 'description' => '文档',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocUuid' => ['title' => '内部文档唯一ID', 'description' => '文档系统唯一ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Title' => ['description' => '文档标题', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'DocId' => ['title' => '用户指定的文档唯一ID', 'description' => '文档用户侧唯一ID', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'Tags' => [
+ 'description' => '标签',
+ 'type' => 'array',
+ 'items' => ['description' => '标签值。', 'type' => 'string', 'required' => false, 'example' => 'xx'],
+ 'required' => false,
+ ],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'required' => false, 'example' => 'xxxx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'required' => false, 'example' => 'xxx'],
+ ],
+ 'required' => true,
],
],
[
- 'name' => 'ContentType',
+ 'name' => 'DatasetId',
'in' => 'formData',
- 'schema' => [
- 'description' => '内容类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'outline'."\n"
- .'bidding',
- ],
+ 'schema' => ['title' => '数据集唯一标识', 'description' => '数据集唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
[
- 'name' => 'ContentFormat',
+ 'name' => 'DatasetName',
'in' => 'formData',
- 'schema' => [
- 'description' => '格式',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'html'."\n"
- .'markdown',
- ],
+ 'schema' => ['title' => '数据集名称', 'description' => '数据集名称', 'type' => 'string', 'required' => false, 'example' => '数据集名称'],
],
],
'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' => 'successful',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误信息。',
- 'type' => 'string',
- 'example' => 'successful',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'Data' => [
+ 'title' => '业务数据',
'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
+ 'DocUuid' => ['title' => '内部文档唯一ID', 'description' => '内部文档唯一ID', 'type' => 'string', 'example' => '内部文档唯一ID'],
+ 'Title' => ['description' => '文档标题', 'type' => 'string', 'example' => '文章标题'],
+ 'DocId' => ['title' => '用户指定的文档唯一ID', 'description' => '用户指定的文档唯一ID', 'type' => 'string', 'example' => '用户指定的文档唯一ID'],
+ 'Tags' => [
+ 'description' => '标签。',
+ 'type' => 'array',
+ 'items' => ['description' => '标签。', 'type' => 'string', 'example' => 'xx'],
],
+ 'CategoryUuid' => ['description' => '类目唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'Extend1' => ['description' => '扩展字段1', 'type' => 'string', 'example' => 'xx'],
+ 'Extend2' => ['description' => '扩展字段2', 'type' => 'string', 'example' => 'xx'],
+ 'Extend3' => ['description' => '扩展字段3', 'type' => 'string', 'example' => 'xx'],
],
],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '数据源-修改文档',
+ 'summary' => '修改数据源文档。',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-18T04:52:17.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"successful\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"successful\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n }\\n}","type":"json"}]',
- 'title' => '编辑标书内容',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"DocUuid\\": \\"内部文档唯一ID\\",\\n \\"Title\\": \\"文章标题\\",\\n \\"DocId\\": \\"用户指定的文档唯一ID\\",\\n \\"Tags\\": [\\n \\"xx\\"\\n ],\\n \\"CategoryUuid\\": \\"xx\\",\\n \\"Extend1\\": \\"xx\\",\\n \\"Extend2\\": \\"xx\\",\\n \\"Extend3\\": \\"xx\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'DownloadBiddingDoc' => [
- 'summary' => '标书下载接口',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateGeneralConfig' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-az2gglkjauwnnhpq',
- ],
+ 'schema' => ['title' => '百炼业务空间唯一标识:[获取workspaceId](~~2587495~~)', 'description' => '百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'ConfigKey',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
- ],
+ 'schema' => ['title' => '配置项唯一标识', 'description' => '配置项唯一标识,支持的配置:'."\n"
+ .'- 妙搜-数据源-文本搜索阈值(double):searchGenerate.searchTextMinScore'."\n"
+ .'- 妙搜-数据源-图片搜索阈值(double):searchGenerate.searchImageMinScore'."\n"
+ .'- 妙搜-数据源-视频搜索阈值(double):searchGenerate.searchVideoMinScore'."\n"
+ .'- 妙搜-数据源-音频搜索阈值(double):searchGenerate.searchAudioMinScore'."\n"
+ .'- 妙搜-问答式搜索-通用-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaAgentPrompt'."\n"
+ .'- 妙搜-问答式搜索-通用-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaAgentVlPrompt'."\n"
+ .'- 妙搜-问答式搜索-深度-总结生成答案-纯文本prompt模版(string):searchGenerate.sumQaEnhanceAgentPrompt'."\n"
+ .'- 妙搜-问答式搜索-深度-总结生成答案-文本&图片prompt模版(string):searchGenerate.sumQaEnhanceAgentVlPrompt', 'type' => 'string', 'required' => true, 'example' => 'xx'],
+ ],
+ [
+ 'name' => 'ConfigValue',
+ 'in' => 'formData',
+ 'schema' => ['title' => '配置值', 'description' => '配置值', 'type' => 'string', 'required' => true, 'example' => 'xxx'],
],
],
'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',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
'Data' => [
- 'description' => '业务数据',
+ 'title' => '配置项唯一标识',
+ 'description' => '配置项唯一标识',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'description' => '任务id',
- 'type' => 'string',
- 'example' => '111_Default_20250708142918',
- ],
- 'Url' => [
- 'description' => '文章URL',
- 'type' => 'string',
- 'example' => 'https://www.example.com/aaa.docx',
- ],
+ 'ConfigKey' => ['title' => '配置值', 'description' => '配置唯一标识', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigValue' => ['title' => '创建者', 'description' => '配置值', 'type' => 'string', 'example' => 'xxx'],
+ 'ConfigValueType' => ['title' => '配置值类型', 'description' => '配置值类型', 'type' => 'string', 'example' => 'xx'],
+ 'ConfigDesc' => ['title' => '配置项说明', 'description' => '配置项说明', 'type' => 'string', 'example' => 'xxx'],
],
],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '通用配置-修改',
+ 'summary' => '通用配置-修改。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"111_Default_20250708142918\\",\\n \\"Url\\": \\"https://www.example.com/aaa.docx\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
- 'title' => '下载标书文件',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xxx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xxx\\"\\n },\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Code\\": \\"NoData\\",\\n \\"Message\\": \\"success\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]',
],
- 'AsyncWritingBiddingDoc' => [
- 'summary' => '标书写作接口',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateGeneratedContent' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
- 'in' => 'formData',
- 'schema' => [
- 'description' => '[业务空间id](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务唯一ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1',
- ],
+ 'schema' => ['title' => '文档唯一标识', 'description' => '文档唯一标识', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36'],
],
[
'name' => 'Prompt',
'in' => 'formData',
- 'schema' => [
- 'description' => '提示词',
- 'type' => 'string',
- 'required' => false,
- 'example' => '自定义观点的输入Prompt',
- ],
+ 'schema' => ['title' => '最后一次生成的提示词', 'description' => '最后一次生成的提示词', 'type' => 'string', 'required' => false, 'example' => '创作xx文章'],
],
[
- 'name' => 'CompanyKeyword',
+ 'name' => 'Title',
'in' => 'formData',
+ 'schema' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'required' => false, 'example' => '文章名称', 'maxLength' => 200, 'minLength' => 2],
+ ],
+ [
+ 'name' => 'Content',
+ 'in' => 'formData',
+ 'schema' => ['title' => '正文:富文本', 'description' => '正文:富文本', 'type' => 'string', 'required' => false, 'example' => '正文'],
+ ],
+ [
+ 'name' => 'ContentText',
+ 'in' => 'formData',
+ 'schema' => ['title' => '正文:纯文本', 'description' => '正文:纯文本', 'type' => 'string', 'required' => false, 'example' => '正文'],
+ ],
+ [
+ 'name' => 'Keywords',
+ 'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '投标公司名称',
- 'type' => 'string',
+ 'title' => '关键词',
+ 'description' => '关键词',
+ 'type' => 'array',
+ 'items' => ['description' => '关键字', 'type' => 'string', 'required' => false, 'example' => '登机'],
'required' => false,
- 'example' => 'comany name',
],
],
],
'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' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http错误码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'Data' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- ],
- ],
- 'Code' => [
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'successful',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'boolean', 'example' => 'false'],
+ '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'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新文档',
+ 'summary' => '更新文档:用来更新妙笔中创作的文章历史。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGeneratedContent'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]',
- 'title' => '标书写作',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": false,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
- 'ListBiddingDoc' => [
- 'summary' => '获得标书写作任务列表',
- 'path' => '',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'UpdateMaterialDocument' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'write',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- ],
+ 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
- 'name' => 'WorkspaceId',
+ 'name' => 'AgentKey',
+ 'in' => 'query',
+ 'schema' => ['title' => '业务空间唯一标识:AgentKey', 'description' => '业务空间唯一标识:[AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public'],
+ ],
+ [
+ 'name' => 'Id',
'in' => 'formData',
- 'schema' => [
- 'description' => '[业务空间ID](~~2782167~~)',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['title' => '主键', 'description' => '主键', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '44'],
],
[
- 'name' => 'TaskName',
+ 'name' => 'DocType',
'in' => 'formData',
'schema' => [
- 'description' => '任务名称定义',
+ 'title' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
+ 'description' => '文档类型 (html: 网页, plainText: 纯文本, image: 图片, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)',
'type' => 'string',
- 'required' => false,
- 'example' => '任务名称',
+ 'required' => true,
+ 'example' => 'image',
+ 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine'],
],
],
[
- 'name' => 'TaskStatus',
+ 'name' => 'Title',
'in' => 'formData',
- 'schema' => [
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '0-waiting、1-running、2-success、3-pause、4-fail',
- ],
+ 'schema' => ['title' => '文档标题', 'description' => '文档标题', 'type' => 'string', 'required' => false, 'example' => '标题'],
],
[
- 'name' => 'CreateTimeStart',
+ 'name' => 'Author',
'in' => 'formData',
- 'schema' => [
- 'description' => '起始创建时间,时间戳形式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-02-19 07:28:11',
- ],
+ 'schema' => ['title' => '作者', 'description' => '作者', 'type' => 'string', 'required' => false, 'example' => '作者名称'],
],
[
- 'name' => 'CreateTimeEnd',
+ 'name' => 'PubTime',
'in' => 'formData',
- 'schema' => [
- 'description' => '截止创建时间,时间戳形式。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '2023-03-18 02:00:00',
- ],
+ 'schema' => ['title' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'description' => '发布时间,格式:yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-04-11 06:14:07'],
],
[
- 'name' => 'Current',
+ 'name' => 'DocKeywords',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '文档标签用于分类等',
+ 'description' => '文档标签用于分类等',
+ 'type' => 'array',
+ 'items' => ['description' => '关键词', 'type' => 'string', 'required' => false, 'example' => '关键词'],
'required' => false,
- 'example' => '1',
],
],
[
- 'name' => 'Size',
+ 'name' => 'Url',
'in' => 'formData',
- 'schema' => [
- 'description' => '每页条数:默认10',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
- ],
+ 'schema' => ['title' => '素材的URL', 'description' => '素材的URL', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx/xxx'],
],
[
- 'name' => 'Skip',
+ 'name' => 'ExternalUrl',
+ 'in' => 'formData',
+ 'schema' => ['title' => '外部客户上传的URL,仅用作记录保存', 'description' => '外部客户上传的URL,仅用作记录保存', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx/xxx'],
+ ],
+ [
+ 'name' => 'SrcFrom',
'in' => 'formData',
'schema' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'title' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
+ 'description' => '文档来源 (UserUpload: 用户上传, IntellijSearch: 智搜, HotViewPoint: 热点视角)',
+ 'type' => 'string',
'required' => false,
- 'example' => 'null',
+ 'example' => 'UserUpload',
+ 'enum' => ['UserUpload', 'IntellijSearch', 'HotViewPoint'],
],
],
[
- 'name' => 'MaxResults',
+ 'name' => 'TextContent',
+ 'in' => 'formData',
+ 'schema' => ['title' => '解析后的文本内容,对于图片来说为空', 'description' => '解析后的文本内容,对于图片来说为空', 'type' => 'string', 'required' => false, 'example' => '文本内容'],
+ ],
+ [
+ 'name' => 'HtmlContent',
+ 'in' => 'formData',
+ 'schema' => ['title' => '带格式的内容', 'description' => '带格式的内容', 'type' => 'string', 'required' => false, 'example' => '网页内容'],
+ ],
+ [
+ 'name' => 'ShareAttr',
'in' => 'formData',
'schema' => [
- 'description' => '废弃',
+ 'title' => '共享属性:0:个人私有,1:业务空间范围内共享',
+ 'description' => '共享属性:0:个人私有,1:业务空间范围内共享',
'type' => 'integer',
'format' => 'int32',
'required' => false,
- 'example' => 'null',
+ 'example' => '1',
+ 'enum' => ['0', '1'],
],
],
[
- 'name' => 'NextToken',
+ 'name' => 'Summary',
'in' => 'formData',
- 'schema' => [
- 'description' => '废弃',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'null',
- ],
+ 'schema' => ['title' => '摘要', 'description' => '摘要', 'type' => 'string', 'required' => false, 'example' => '摘要'],
+ ],
+ [
+ 'name' => 'RegionId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'required' => false, 'description' => ''],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'PlainResult<Long>',
+ 'description' => 'PlainResult<Long>',
'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' => 'success',
- ],
- 'HttpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'Message' => [
- 'description' => '错误说明',
- 'type' => 'string',
- 'example' => 'success',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'MaxResults' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'null',
- ],
- 'NextToken' => [
- 'description' => '废弃',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'TotalCount' => [
- 'description' => '废弃',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'null',
- ],
- 'Current' => [
- 'description' => '当前页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'Size' => [
- 'description' => '每页条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Total' => [
- 'description' => '总记录数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'Data' => [
- 'description' => '返回数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '业务数据',
- 'type' => 'object',
- 'properties' => [
- 'TaskId' => [
- 'description' => '任务ID。',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'TaskName' => [
- 'description' => '任务名称',
- 'type' => 'string',
- 'example' => '任务名称',
- ],
- 'TaskStatus' => [
- 'description' => '任务状态',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'CreateTimeStart' => [
- 'description' => '创建时间-开始范围,格式:yyyy-MM-dd HH:mm:ss',
- 'type' => 'string',
- 'example' => '2023-03-18 02:00:00'."\n",
- ],
- 'TaskStep' => [
- 'description' => '任务阶段',
- 'type' => 'string',
- 'example' => 'analysis'."\n"
- .'writing',
- ],
- ],
- ],
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'DataNotExists'],
+ 'Data' => ['title' => '业务数据', 'description' => '业务数据', 'type' => 'integer', 'format' => 'int64', 'example' => '82'],
+ 'HttpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['title' => '错误说明', 'description' => '错误说明', 'type' => 'string', 'example' => '数据不存在'],
+ 'RequestId' => ['title' => '请求唯一标识', 'description' => '请求唯一标识', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Success' => ['title' => '是否成功:true 成功,false 失败', 'description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'false'],
],
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ 'errorCodes' => [],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '更新素材',
+ 'summary' => '更新素材:更新素材库中素材。',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => '错误码发生变更、请求参数发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateMaterialDocument'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateMaterialDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ 'additionalActions' => [],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Code\\": \\"success\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"MaxResults\\": 0,\\n \\"NextToken\\": \\"null\\",\\n \\"TotalCount\\": 0,\\n \\"Current\\": 1,\\n \\"Size\\": 10,\\n \\"Total\\": 10,\\n \\"Data\\": [\\n {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"TaskName\\": \\"任务名称\\",\\n \\"TaskStatus\\": 1,\\n \\"CreateTimeStart\\": \\"2023-03-18 02:00:00\\\\n\\",\\n \\"TaskStep\\": \\"analysis\\\\nwriting\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '列出标书写作任务',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": 82,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]',
],
- 'RunVideoScriptGenerate' => [
- 'summary' => 'AI生成视频剪辑脚本',
- 'path' => '/miaobi/runVideoScriptGenerate',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'UploadBook' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -48074,104 +28925,36 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'llm-xx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:[获取workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-ipe7d81yq4sl5jmk'],
],
[
- 'name' => 'Prompt',
+ 'name' => 'Docs',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '视频脚本的提示词',
- 'description' => '视频脚本的提示词',
- 'type' => 'string',
+ 'description' => '文档',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文档',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocName' => ['description' => '文档名称', 'type' => 'string', 'required' => false, 'example' => '文档1.pdf'],
+ 'FileUrl' => ['description' => '文件 URL', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/ccc.pdf'],
+ ],
+ 'required' => false,
+ ],
'required' => true,
- 'example' => '写一篇关于黄山旅游的脚本',
- ],
- ],
- [
- 'name' => 'UseSearch',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '是否使用联网检索(如果选是,则会意图理解后联网检索相关参考素材)',
- 'description' => '是否使用联网检索(如果选是,则会意图理解后联网检索相关参考素材)',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- [
- 'name' => 'ScriptLength',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '脚本篇幅 描述 可选值有:'."\n"
- ."\n"
- .'20~75:10~15s正常口播时长'."\n"
- .'75~150:15~30s正常口播时长'."\n"
- .'150~300:≈30~60s正常口播时长'."\n"
- .'>=300:≥60s正常口播时长',
- 'description' => '脚本篇幅 描述 可选值有:'."\n"
- ."\n"
- .'20~75:10~15s正常口播时长'."\n"
- ."\n"
- .'75~150:15~30s正常口播时长'."\n"
- ."\n"
- .'150~300:≈30~60s正常口播时长'."\n"
- ."\n"
- .'\\>=300:≥60s正常口播时长',
- 'type' => 'string',
- 'required' => false,
- 'example' => '>=300',
- ],
- ],
- [
- 'name' => 'Language',
- 'in' => 'formData',
- 'schema' => [
- 'title' => '生成脚本的语言:'."\n"
- .'建议取值有:'."\n"
- .'zh-CN: 中文,'."\n"
- .'en-US: 英文.'."\n"
- .'默认中文',
- 'description' => '生成脚本的语言:'."\n"
- .'建议取值有:'."\n"
- ."\n"
- .'zh-CN: 中文'."\n"
- ."\n"
- .'en-US: 英文'."\n"
- ."\n"
- .'默认中文',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'en-US',
],
],
[
- 'name' => 'ScriptNumber',
+ 'name' => 'CategoryId',
'in' => 'formData',
- 'schema' => [
- 'title' => '生成脚本的篇数。默认1篇,最多同时生成三篇'."\n"
- .'如果指定多篇。则会并行返回流式多个脚本生成结果。(客户端通过不同sessionId区分)',
- 'description' => '生成脚本的篇数。默认1篇,最多同时生成三篇'."\n"
- .'如果指定多篇。则会并行返回流式多个脚本生成结果。(客户端通过不同sessionId区分)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '2',
- ],
+ 'schema' => ['description' => '目录ID', 'type' => 'string', 'required' => false, 'example' => 'default'],
],
],
'responses' => [
@@ -48181,141 +28964,61 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Header' => [
- 'description' => '响应头',
- 'type' => 'object',
- 'properties' => [
- 'ErrorCode' => [
- 'description' => '异常错误码',
- 'type' => 'string',
- 'example' => 'ScriptNumberExceed',
- ],
- 'ErrorMessage' => [
- 'description' => '调用失败时,返回的出错信息。',
- 'type' => 'string',
- 'example' => '脚本篇数超限',
- ],
- 'Event' => [
- 'description' => 'event名称',
- 'type' => 'string',
- 'example' => 'result-generated'."\n",
- ],
- 'SessionId' => [
- 'description' => '会话ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
- 'StatusCode' => [
- 'description' => '状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '400',
- ],
- 'TaskId' => [
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => 'b057f2fa-2277-477b-babf-cbc062307828',
- ],
- 'TraceId' => [
- 'description' => '全链路ID',
- 'type' => 'string',
- 'example' => '2150451a17191950923411783e2927',
- ],
- ],
- ],
- 'Payload' => [
- 'description' => '响应体',
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'],
+ 'Code' => ['description' => '状态码', 'type' => 'string', 'example' => 'successful'],
+ 'Data' => [
+ 'description' => '业务数据',
'type' => 'object',
'properties' => [
- 'Output' => [
- 'description' => '输出内容对象',
- 'type' => 'object',
- 'properties' => [
- 'Text' => [
- 'description' => '文本生成结果',
- 'type' => 'string',
- 'example' => '大家好,我是[xxx]。今天带大家走进黄山,感受奇松、怪石、云海、温泉的绝美风光。首站迎客松,800年历史,枝干如臂,热情迎接每一位游客。接着登光明顶,360度全景尽收眼底。再探秘西海大峡谷,体验原始自然的震撼。最后,在温泉中放松身心,享受旅途的美好。希望这次旅行能给你留下难忘的记忆。我是[你的名字],感谢观看,我们下次再见!","91522b25a4f440189320c9ede8ae6c85":"大家好,我是[您的名字],今天带大家探索黄山的奇妙之旅。首先,我们将见到黄山的象征——迎客松,感受它800年的历史与欢迎。随后攀登光明顶,迎接壮丽的日出;漫步西海大峡谷,体验险峻之美;最后,在温泉中放松身心。希望这次旅行能让你爱上黄山。谢谢观看!","1c23af4a899e4b908bdcffa7d8d0ddc9":"大家好,欢迎来到黄山!这里以奇松、怪石、云海、温泉四绝闻名。从云谷寺开始,感受古朴氛围;挑战百步云梯,体验攀登乐趣;漫步西海大峡谷,领略壮丽景色;最后在玉屏楼迎接日出,享受心灵的宁静。希望这次旅行给你留下美好回忆!',
- ],
- ],
+ 'DocIds' => [
+ 'description' => '文档ID',
+ 'type' => 'array',
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'example' => 'aaaxxx'],
],
- 'Usage' => [
- 'description' => 'token用量',
- 'type' => 'object',
- 'properties' => [
- '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',
- ],
- ],
+ 'ExistedIds' => [
+ 'description' => '错误文档Id',
+ 'type' => 'array',
+ 'items' => ['description' => '文档Id', 'type' => 'string', 'example' => 'ccccc'],
],
],
],
- 'RequestId' => [
- 'description' => '请求唯一标识(当Content-Type返回json时 会返回该字段)',
- 'type' => 'string',
- 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5',
- ],
- 'HttpStatusCode' => [
- 'description' => 'HTTP状态码(当Content-Type返回json时 会返回该字段)',
- 'type' => 'string',
- 'example' => '403',
- ],
- 'Code' => [
- 'description' => '状态码,正常返回200(当Content-Type返回json时 会返回该字段)',
- 'type' => 'string',
- 'example' => 'NoPermission',
- ],
- 'Message' => [
- 'description' => '错误说明(当Content-Type返回json时 会返回该字段)',
- 'type' => 'string',
- 'example' => 'You are not authorized to perform this action.',
- ],
- 'Success' => [
- 'description' => '是否成功:true 成功,false 失败(当Content-Type返回json时 会返回该字段)',
- 'type' => 'boolean',
- 'example' => 'false',
- ],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'Success' => ['description' => '是否成功:true 成功,false 失败', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'NoPermission',
- 'errorMessage' => 'You are not authorized to perform this action.',
- ],
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"ScriptNumberExceed\\",\\n \\"ErrorMessage\\": \\"脚本篇数超限\\",\\n \\"Event\\": \\"result-generated\\\\n\\",\\n \\"SessionId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"StatusCode\\": 400,\\n \\"TaskId\\": \\"b057f2fa-2277-477b-babf-cbc062307828\\",\\n \\"TraceId\\": \\"2150451a17191950923411783e2927\\"\\n },\\n \\"Payload\\": {\\n \\"Output\\": {\\n \\"Text\\": \\"大家好,我是[xxx]。今天带大家走进黄山,感受奇松、怪石、云海、温泉的绝美风光。首站迎客松,800年历史,枝干如臂,热情迎接每一位游客。接着登光明顶,360度全景尽收眼底。再探秘西海大峡谷,体验原始自然的震撼。最后,在温泉中放松身心,享受旅途的美好。希望这次旅行能给你留下难忘的记忆。我是[你的名字],感谢观看,我们下次再见!\\\\\\",\\\\\\"91522b25a4f440189320c9ede8ae6c85\\\\\\":\\\\\\"大家好,我是[您的名字],今天带大家探索黄山的奇妙之旅。首先,我们将见到黄山的象征——迎客松,感受它800年的历史与欢迎。随后攀登光明顶,迎接壮丽的日出;漫步西海大峡谷,体验险峻之美;最后,在温泉中放松身心。希望这次旅行能让你爱上黄山。谢谢观看!\\\\\\",\\\\\\"1c23af4a899e4b908bdcffa7d8d0ddc9\\\\\\":\\\\\\"大家好,欢迎来到黄山!这里以奇松、怪石、云海、温泉四绝闻名。从云谷寺开始,感受古朴氛围;挑战百步云梯,体验攀登乐趣;漫步西海大峡谷,领略壮丽景色;最后在玉屏楼迎接日出,享受心灵的宁静。希望这次旅行给你留下美好回忆!\\"\\n },\\n \\"Usage\\": {\\n \\"InputTokens\\": 100,\\n \\"OutputTokens\\": 100,\\n \\"TotalTokens\\": 200\\n }\\n },\\n \\"RequestId\\": \\"F2F366D6-E9FE-1006-BB70-2C650896AAB5\\",\\n \\"HttpStatusCode\\": \\"403\\",\\n \\"Code\\": \\"NoPermission\\",\\n \\"Message\\": \\"You are not authorized to perform this action.\\",\\n \\"Success\\": false\\n}","type":"json"}]',
- 'title' => 'AI生成视频剪辑脚本',
- ],
- 'GetSmartClipTask' => [
- 'summary' => '查询一键成片剪辑任务。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '书籍上传',
+ 'summary' => '妙读上传书籍。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UploadBook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DocIds\\": [\\n \\"aaaxxx\\"\\n ],\\n \\"ExistedIds\\": [\\n \\"ccccc\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'UploadDoc' => [
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -48323,836 +29026,3137 @@
],
'operationType' => 'readAndWrite',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx',
- ],
+ 'schema' => ['description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-yigtrrjl377rcbab'],
],
[
- 'name' => 'TaskId',
+ 'name' => 'Docs',
'in' => 'formData',
+ 'style' => 'json',
'schema' => [
- 'title' => '任务ID',
- 'description' => '任务唯一标识'."\n"
- .'> TaskId默认无需填写,系统将自动生成。当后续任务填写的TaskId相同时,表示这些任务属于同一组对话。'."\n"
- .'>',
- 'type' => 'string',
+ 'description' => '文档',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '文档',
+ 'type' => 'object',
+ 'properties' => [
+ 'DocName' => ['description' => '文档名称', 'type' => 'string', 'required' => true, 'example' => '文档1.pdf'],
+ 'FileUrl' => ['description' => '文件url', 'type' => 'string', 'required' => true, 'example' => 'http://xxx/ccc.pdf'],
+ ],
+ 'required' => true,
+ ],
'required' => true,
- 'example' => 'task-03d46184ee7d8749',
],
],
+ [
+ 'name' => 'CategoryId',
+ 'in' => 'formData',
+ 'schema' => ['description' => '文档所在目录,如果不填值是default', 'type' => 'string', 'required' => false, 'example' => 'default'],
+ ],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
- 'title' => 'PlainResult',
- 'description' => 'PlainResult',
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['description' => '内部错误码', 'type' => 'string', 'example' => 'successful'],
'Data' => [
- 'title' => '任务响应结果',
- 'description' => '任务响应结果',
+ 'description' => '文档信息',
'type' => 'object',
'properties' => [
- 'Status' => [
- 'title' => '任务状态:'."\n"
- .' PENDING:待执行'."\n"
- .' RUNNING:执行中'."\n"
- .' SUCCESSED:成功'."\n"
- .' FAILED:失败'."\n"
- .' CANCELED:已取消',
- 'description' => '任务状态:'."\n"
- .' PENDING:待执行'."\n"
- .' RUNNING:执行中'."\n"
- .' SUCCESSED:成功'."\n"
- .' FAILED:失败'."\n"
- .' CANCELED:已取消',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'ErrorMessage' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '错误信息',
+ 'DocIds' => [
+ 'description' => '成功的文档Id数组',
+ 'type' => 'array',
+ 'items' => ['description' => '文档ID', 'type' => 'string', 'example' => 'aaaxxx'],
],
- 'SubJobs' => [
- 'title' => '子任务列表',
- 'description' => '子任务列表',
+ 'ExistedIds' => [
+ 'description' => '因为已经存在无法上传的文档Id',
'type' => 'array',
- 'items' => [
- 'title' => '子任务',
- 'description' => '子任务',
- 'type' => 'object',
- 'properties' => [
- 'SubJobId' => [
- 'title' => '子任务ID',
- 'description' => '子任务ID',
- 'type' => 'string',
- 'example' => 'xxxxx',
- ],
- 'Status' => [
- 'title' => '子任务状态'."\n"
- .' PENDING:待执行'."\n"
- .' RUNNING:执行中'."\n"
- .' SUCCESSED:成功'."\n"
- .' FAILED:失败'."\n"
- .' CANCELED:已取消',
- 'description' => '子任务状态'."\n"
- .' PENDING:待执行'."\n"
- .' RUNNING:执行中'."\n"
- .' SUCCESSED:成功'."\n"
- .' FAILED:失败'."\n"
- .' CANCELED:已取消',
- 'type' => 'string',
- 'example' => 'RUNNING',
- ],
- 'ErrorMessage' => [
- 'title' => '错误消息',
- 'description' => '错误消息',
- 'type' => 'string',
- 'example' => '文件名错误',
- ],
- 'FileKey' => [
- 'title' => '文件FileKey',
- 'description' => '文件FileKey',
- 'type' => 'string',
- 'example' => 'oss://default/bucket-name/path-xxx/xxx-1.mp4',
- ],
- 'FileAttr' => [
- 'title' => '文件属性',
- 'description' => '文件属性',
- 'type' => 'object',
- 'properties' => [
- 'FileName' => [
- 'title' => '视频文件名称',
- 'description' => '视频文件名称',
- 'type' => 'string',
- 'example' => '2024-12-12.mp4',
- ],
- 'FileLength' => [
- 'title' => '视频文件大小',
- 'description' => '视频文件大小',
- 'type' => 'string',
- 'example' => '290804',
- ],
- 'TmpUrl' => [
- 'title' => '视频文件临时访问URL。1小时过期',
- 'description' => '视频文件临时访问URL。1小时过期',
- 'type' => 'string',
- 'example' => 'http://www.example.com/tmp.mp4',
- ],
- 'Duration' => [
- 'title' => '视频时长,单位秒',
- 'description' => '视频时长,单位秒',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '120',
- ],
- 'Height' => [
- 'title' => '视频高度',
- 'description' => '视频高度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1080',
- ],
- 'Width' => [
- 'title' => '视频宽度',
- 'description' => '视频宽度',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1920',
- ],
- ],
- ],
- ],
- ],
+ 'items' => ['description' => '文档Id', 'type' => 'string', 'example' => 'ccccc'],
],
],
],
- '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',
- ],
+ 'HttpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'Message' => ['description' => '错误说明', 'type' => 'string', 'example' => 'success'],
+ 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'],
+ 'Success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => '请检查workspaceId的赋值'],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"错误信息\\",\\n \\"SubJobs\\": [\\n {\\n \\"SubJobId\\": \\"xxxxx\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"ErrorMessage\\": \\"文件名错误\\",\\n \\"FileKey\\": \\"oss://default/bucket-name/path-xxx/xxx-1.mp4\\",\\n \\"FileAttr\\": {\\n \\"FileName\\": \\"2024-12-12.mp4\\",\\n \\"FileLength\\": \\"290804\\",\\n \\"TmpUrl\\": \\"http://www.example.com/tmp.mp4\\",\\n \\"Duration\\": 120,\\n \\"Height\\": 1080,\\n \\"Width\\": 1920\\n }\\n }\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '获取智能剪辑任务结果',
- ],
- 'SubmitSmartClipTask' => [
- 'summary' => '提交一键成片剪辑任务。',
- 'path' => '',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'gatewayOptions' => [
+ 'gatewayProtocols' => [],
],
- 'schemes' => [
- 'https',
+ 'title' => '文档上传',
+ 'summary' => '妙读上传文档接口。',
+ 'description' => '文档上传是通过异步调用的方式实现,调用之后需要使用getDocInfo接口进行循环检查文档状态,当文档状态为1时,才能进行后续的文档摘要、生成全文脑图、问答内容总结、抽取关键词、改写等操作。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UploadDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"successful\\",\\n \\"Data\\": {\\n \\"DocIds\\": [\\n \\"aaaxxx\\"\\n ],\\n \\"ExistedIds\\": [\\n \\"ccccc\\"\\n ]\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
+ ],
+ 'ValidateUploadTemplate' => [
+ 'path' => '',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'tenantRelevance' => 'tenant',
- ],
+ 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'],
'parameters' => [
[
'name' => 'WorkspaceId',
'in' => 'formData',
- 'schema' => [
- 'title' => '业务空间ID',
- 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '业务空间ID',
- ],
- ],
- [
- 'name' => 'InputConfig',
- 'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '输入配置',
- 'description' => '输入配置',
- 'type' => 'object',
- 'properties' => [
- 'VideoIds' => [
- 'title' => '视频素材ID对象列表',
- 'description' => '视频素材ID对象列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '素材ID对象',
- 'description' => '素材ID对象',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => 'ID的类型:'."\n"
- .'materialId: 妙笔素材库引用ID'."\n"
- .'fileKey: 妙笔FileKey'."\n"
- .'url: 可公开访问的URL',
- 'description' => 'ID的类型:'."\n"
- .'materialId:妙笔素材库引用ID'."\n"
- .'fileKey:妙笔FileKey'."\n"
- .'url:可公开访问的URL',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fileKey',
- ],
- 'Id' => [
- 'title' => '素材ID',
- 'description' => '素材ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://default/bucket-name/filepath/video.mp4',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'Titles' => [
- 'title' => '标题列表',
- 'description' => '标题列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '标题',
- 'description' => '标题',
- 'type' => 'string',
- 'required' => false,
- 'example' => '视频标题',
- ],
- 'required' => false,
- ],
- 'BackgroundMusics' => [
- 'title' => '背景音乐ID列表',
- 'description' => '背景音乐ID列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '背景音乐ID对象',
- 'description' => '背景音乐ID对象',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => 'ID的类型:'."\n"
- .'materialId: 妙笔素材库引用ID'."\n"
- .'fileKey: 妙笔FileKey'."\n"
- .'url: 可公开访问的URL',
- 'description' => 'ID的类型:'."\n"
- .'materialId:妙笔素材库引用ID'."\n"
- .'fileKey:妙笔FileKey'."\n"
- .'url:可公开访问的URL',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fileKey',
- ],
- 'Id' => [
- 'title' => '背景音乐ID',
- 'description' => '背景音乐ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://default/bucket-name/filepath/video.mp3',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'Stickers' => [
- 'title' => '贴纸列表',
- 'description' => '贴纸列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '贴纸对象',
- 'description' => '贴纸对象',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'title' => '贴纸左上角X坐标',
- 'description' => '贴纸左上角X坐标',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => true,
- 'example' => '0.5',
- ],
- 'Y' => [
- 'title' => '贴纸左上角Y坐标',
- 'description' => '贴纸左上角Y坐标',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => true,
- 'example' => '0.5',
- ],
- 'Width' => [
- 'title' => '贴纸宽度',
- 'description' => '贴纸宽度',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => true,
- 'example' => '0.5',
- ],
- 'Height' => [
- 'title' => '贴纸高度',
- 'description' => '贴纸高度',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => true,
- 'example' => '0.5',
- ],
- 'StickerId' => [
- 'title' => '贴纸ID',
- 'description' => '贴纸ID',
- 'type' => 'object',
- 'properties' => [
- 'Type' => [
- 'title' => 'ID的类型:'."\n"
- .'materialId: 妙笔素材库引用ID'."\n"
- .'fileKey: 妙笔FileKey'."\n"
- .'url: 可公开访问的URL',
- 'description' => 'ID的类型:'."\n"
- .'materialId:妙笔素材库引用ID'."\n"
- .'fileKey:妙笔FileKey'."\n"
- .'url:可公开访问的URL',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'fileKey',
- ],
- 'Id' => [
- 'title' => '贴纸ID',
- 'description' => '贴纸ID',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'oss://default/bucket-name/filepath/sticker.png',
- ],
- ],
- 'required' => true,
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'SpeechTexts' => [
- 'title' => '口播脚本文本列表',
- 'description' => '口播脚本文本列表',
- 'type' => 'array',
- 'items' => [
- 'title' => '语音识别文本',
- 'description' => '口播脚本文本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '大家好,欢迎来到我的频道xxx',
- ],
- 'required' => false,
- ],
- ],
- 'required' => true,
- ],
+ 'schema' => ['title' => '业务空间ID', 'description' => '阿里云百炼业务空间唯一标识:获取[业务空间ID(Workspace ID)](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'],
],
[
- 'name' => 'OutputConfig',
+ 'name' => 'TemplateType',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '输出配置',
- 'description' => '输出配置',
- 'type' => 'object',
- 'properties' => [
- 'FileName' => [
- 'title' => '输出文件名,必须包含{index}',
- 'description' => '输出文件名,必须包含{index}',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'test_{index}.mp4',
- 'pattern' => '.*\\{index\\}.*',
- ],
- 'Width' => [
- 'title' => '输出视频宽',
- 'description' => '输出视频宽',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1920',
- ],
- 'Height' => [
- 'title' => '输出视频高',
- 'description' => '输出视频高',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1080',
- ],
- 'Count' => [
- 'title' => '输出视频数量',
- 'description' => '输出视频数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'MaxDuration' => [
- 'title' => '输出视频最大时长,单位:秒',
- 'description' => '输出视频最大时长,单位:秒',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '120',
- ],
- 'SaveToGeneratedContent' => [
- 'title' => '是否保存至内容管理',
- 'description' => '是否保存至内容管理',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '模板类型(Content:表示内容素材模板校验 PositiveSample:正面样本)', 'description' => '模板类型(Content:表示内容素材模板校验,PositiveSample:正面样本)', 'type' => 'string', 'required' => true, 'example' => 'Content'],
],
[
- 'name' => 'EditingConfig',
+ 'name' => 'FileKey',
'in' => 'formData',
- 'style' => 'json',
- 'schema' => [
- 'title' => '剪辑配置',
- 'description' => '剪辑配置',
- 'type' => 'object',
- 'properties' => [
- 'TitleConfig' => [
- 'title' => '标题配置',
- 'description' => '标题配置',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'title' => '横幅文字左上角距离输出视频左上角的横向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。',
- 'description' => '横幅文字左上角距离输出视频左上角的横向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '100',
- ],
- 'Y' => [
- 'title' => '横幅文字左上角距离输出视频左上角的纵向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放',
- 'description' => '横幅文字左上角距离输出视频左上角的纵向距离。注:支持百分比和像素两种形式。当取值为[0~0.9999] 时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '100',
- ],
- 'TimelineIn' => [
- 'title' => '标题出现的时间',
- 'description' => '标题出现的时间',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '2',
- ],
- 'TimelineOut' => [
- 'title' => '标题消失的时间',
- 'description' => '标题消失的时间',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- 'example' => '3',
- ],
- 'Alignment' => [
- 'title' => 'TopLeft:视频左上角 '."\n"
- .'TopCenter:视频竖直中轴线上侧 '."\n"
- .'TopRight:视频右上角 '."\n"
- .'CenterLeft:视频水平中轴线左侧 '."\n"
- .'CenterCenter:视频中心位置 '."\n"
- .'CenterRight:视频水平中轴线右侧 '."\n"
- .'BottomLeft:视频左下角 '."\n"
- .'BottomCenter:视频竖直中轴线下侧 '."\n"
- .'BottomRight:视频右下角',
- 'description' => 'TopLeft:视频左上角 '."\n"
- .'TopCenter:视频竖直中轴线上侧 '."\n"
- .'TopRight:视频右上角 '."\n"
- .'CenterLeft:视频水平中轴线左侧 '."\n"
- .'CenterCenter:视频中心位置 '."\n"
- .'CenterRight:视频水平中轴线右侧 '."\n"
- .'BottomLeft:视频左下角 '."\n"
- .'BottomCenter:视频竖直中轴线下侧 '."\n"
- .'BottomRight:视频右下角',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'TopLeft',
- ],
- ],
- 'required' => false,
- ],
- 'MediaConfig' => [
- 'title' => '媒体配置',
- 'description' => '媒体配置',
- 'type' => 'object',
- 'properties' => [
- 'Volume' => [
- 'title' => '视频素材声音(0:静音)',
- 'description' => '视频素材声音(0:静音)',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'SpeechConfig' => [
- 'title' => '口播配置',
- 'description' => '口播配置',
- 'type' => 'object',
- 'properties' => [
- 'Volume' => [
- 'title' => '口播音频的音量,默认1。取值:[0, 10.0],支持小数,例:0.5。',
- 'description' => '口播音频的音量,默认1。取值:[0, 10.0],支持小数,例:0.5。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.5',
- 'default' => '1',
- ],
- 'Voice' => [
- 'title' => '指定单个或多个口播音色(英文逗号分隔)。当指定多个voice时,会随机选取一个合成。音色的可选范围请参见[智能语音效果示例](https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example?spm=a2c4g.11186623.0.0.13091ee6Pw4Jqz)。例:"zhimiao_emo,zhilun"。',
- 'description' => '指定单个或多个口播音色(英文逗号分隔)。当指定多个voice时,会随机选取一个合成。音色的可选范围请参见[智能语音效果示例](https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example?spm=a2c4g.11186623.0.0.13091ee6Pw4Jqz)。例:"zhimiao_emo,zhilun"。',
- 'type' => 'string',
- 'required' => false,
- ],
- 'Style' => [
- 'title' => '口播声音风格,默认为空。若同时指定Voice和Style,则优先取用Voice'."\n"
- .'"Gentle": 柔和'."\n"
- .'"Serious":严肃'."\n"
- .'"Entertainment":娱乐',
- 'description' => '口播声音风格,默认为空。若同时指定Voice和Style,则优先取用Voice'."\n"
- .'"Gentle": 柔和'."\n"
- .'"Serious":严肃'."\n"
- .'"Entertainment":娱乐',
- 'type' => 'string',
- 'required' => false,
- ],
- 'SpeechRate' => [
- 'title' => '口播脚本语速'."\n"
- .'语速,取值范围:-500~500,默认值:0。'."\n"
- .'[-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]。'."\n"
- ."\n"
- .'计算方法如下:'."\n"
- .'0.8倍速(1-1/0.8)/0.002 = -125'."\n"
- .'1.2倍速(1-1/1.2)/0.001 = 166'."\n"
- .'小于1倍速时,使用0.002系数。'."\n"
- .'大于1倍速时,使用0.001系数。'."\n"
- .'实际算法结果取近似值。',
- 'description' => '口播脚本语速'."\n"
- .'语速,取值范围:-500~500,默认值:0。'."\n"
- .'[-500, 0, 500] 对应的语速倍速区间为 [0.5, 1.0, 2.0]。'."\n"
- ."\n"
- .'计算方法如下:'."\n"
- .'0.8倍速(1-1/0.8)/0.002 = -125'."\n"
- .'1.2倍速(1-1/1.2)/0.001 = 166'."\n"
- .'小于1倍速时,使用0.002系数。'."\n"
- .'大于1倍速时,使用0.001系数。'."\n"
- .'实际算法结果取近似值。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0',
- 'default' => '0',
- ],
- 'AsrConfig' => [
- 'title' => '字幕参数配置',
- 'description' => '字幕参数配置',
- 'type' => 'object',
- 'properties' => [
- 'X' => [
- 'title' => '横幅文字左上角距离输出视频左上角的横向距离'."\n"
- .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。',
- 'description' => '横幅文字左上角距离输出视频左上角的横向距离'."\n"
- .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频宽的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- ],
- 'Y' => [
- 'title' => '横幅文字左上角距离输出视频左上角的纵向距离'."\n"
- .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。',
- 'description' => '横幅文字左上角距离输出视频左上角的纵向距离'."\n"
- .'注:支持百分比和像素两种形式。当取值为[0~0.9999]时,表示相对输出视频高的占比。当取值为>=2的整数时,表示绝对像素。默认为0。该坐标会按照素材尺寸和成片尺寸进行缩放。',
- 'type' => 'number',
- 'format' => 'float',
- 'required' => false,
- ],
- 'Alignment' => [
- 'title' => '字幕对齐'."\n"
- .'TopLeft:视频左上角'."\n"
- .'TopCenter:视频竖直中轴线上侧'."\n"
- .'TopRight:视频右上角'."\n"
- .'CenterLeft:视频水平中轴线左侧'."\n"
- .'CenterCenter:视频中心位置'."\n"
- .'CenterRight:视频水平中轴线右侧'."\n"
- .'BottomLeft:视频左下角'."\n"
- .'BottomCenter:视频竖直中轴线下侧'."\n"
- .'BottomRight:视频右下角',
- 'description' => '字幕对齐'."\n"
- .'TopLeft:视频左上角'."\n"
- .'TopCenter:视频竖直中轴线上侧'."\n"
- .'TopRight:视频右上角'."\n"
- .'CenterLeft:视频水平中轴线左侧'."\n"
- .'CenterCenter:视频中心位置'."\n"
- .'CenterRight:视频水平中轴线右侧'."\n"
- .'BottomLeft:视频左下角'."\n"
- .'BottomCenter:视频竖直中轴线下侧'."\n"
- .'BottomRight:视频右下角',
- 'type' => 'string',
- 'required' => false,
- ],
- 'Font' => [
- 'title' => '字幕文字的字体。具体支持的字体参见字体列表。默认为SimSun字体。',
- 'description' => '字幕文字的字体。具体支持的字体参见字体列表。默认为SimSun字体。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'SimSun',
- 'default' => 'SimSun',
- ],
- 'FontColor' => [
- 'title' => '字幕文字的颜色,格式为#后跟16进制值。例如:#ffffff。',
- 'description' => '字幕文字的颜色,格式为#后跟16进制值。例如:#ffffff。',
- 'type' => 'string',
- 'required' => false,
- 'example' => '#ffffff',
- 'default' => '#ffffff',
- ],
- 'FontSize' => [
- 'title' => '字幕文字的字号。该字号会根据素材尺寸和成片尺寸进行缩放。默认为0,最大支持设置到5000。'."\n",
- 'description' => '字幕文字的字号。该字号会根据素材尺寸和成片尺寸进行缩放。默认为0,最大支持设置到5000。'."\n",
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- 'default' => '0',
- ],
- 'Spacing' => [
- 'title' => '横幅文字字间距。单位:像素值',
- 'description' => '横幅文字字间距。单位:像素值',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0',
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- 'BackgroundMusicConfig' => [
- 'title' => '背景音乐配置',
- 'description' => '背景音乐配置',
- 'type' => 'object',
- 'properties' => [
- 'Volume' => [
- 'title' => '背景音乐的音量,取值:[0, 10.0]',
- 'description' => '背景音乐的音量,取值:[0, 10.0]',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '0.2',
- 'default' => '0.2',
- ],
- 'Style' => [
- 'title' => '背景音乐风格,默认为空,若InputConfig中已配置背景音乐,此字段不生效'."\n"
- .'取值如下:'."\n"
- .'"bgm-beauty":时尚'."\n"
- .'"bgm-chinese-style":中国风'."\n"
- .'"bgm-cuisine":美食'."\n"
- .'"bgm-dynamic":动感'."\n"
- .'"bgm-quirky":怪诞'."\n"
- .'"bgm-relaxing":轻松'."\n"
- .'"bgm-romantic":浪漫'."\n"
- .'"bgm-upbeat":欢快',
- 'description' => '背景音乐风格,默认为空,若InputConfig中已配置背景音乐,此字段不生效'."\n"
- .'取值如下:'."\n"
- .'"bgm-beauty":时尚'."\n"
- .'"bgm-chinese-style":中国风'."\n"
- .'"bgm-cuisine":美食'."\n"
- .'"bgm-dynamic":动感'."\n"
- .'"bgm-quirky":怪诞'."\n"
- .'"bgm-relaxing":轻松'."\n"
- .'"bgm-romantic":浪漫'."\n"
- .'"bgm-upbeat":欢快',
- 'type' => 'string',
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
- ],
- 'required' => false,
- ],
+ 'schema' => ['title' => '文件key', 'description' => '文件key', 'type' => 'string', 'required' => true, 'example' => 'Content'],
],
[
- 'name' => 'ExtendParam',
+ 'name' => 'TaskType',
'in' => 'formData',
- 'schema' => [
- 'title' => '其他扩展参数(会与inputConfig、outputConfig、editingConfig合并)',
- 'description' => '其他扩展参数(会与inputConfig、outputConfig、editingConfig合并)',
- 'type' => 'string',
- 'required' => false,
- ],
+ 'schema' => ['title' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)', 'description' => '任务类型:lightAppSass(Sass页调用)、sdkBatchTask(SDK批量调用任务)', 'type' => 'string', 'required' => false, 'example' => 'lightAppSass'],
],
],
'responses' => [
200 => [
- 'description' => '成功',
'schema' => [
'title' => 'PlainResult',
'description' => 'PlainResult',
'type' => 'object',
'properties' => [
- 'Code' => [
- 'title' => '状态码',
- 'description' => '状态码',
- 'type' => 'string',
- 'example' => 'NoData',
- ],
+ 'Code' => ['title' => '状态码', 'description' => '状态码', 'type' => 'string', 'example' => 'NoData'],
'Data' => [
- 'title' => '任务提交结果',
- 'description' => '任务提交结果',
+ 'title' => '模板校验结果',
+ 'description' => '模板校验结果',
'type' => 'object',
'properties' => [
- 'TaskId' => [
- 'title' => '任务ID',
- 'description' => '任务ID',
- 'type' => 'string',
- 'example' => '3f7045e099474ba28ceca1b4eb6d6e21',
- ],
+ 'TotalCount' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'CommentCount' => ['title' => '评论数', 'description' => '观点数', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'DialogueCount' => ['title' => '对话数量', 'description' => '对话数量', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
],
],
- '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',
- ],
+ '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'],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '校验VOC上传模板',
+ 'summary' => '校验企业VOC上传模板。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\"\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
- 'title' => '提交智能一键成片任务',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ValidateUploadTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 50,\\n \\"CommentCount\\": 50,\\n \\"DialogueCount\\": 50\\n },\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true\\n}","type":"json"}]',
],
],
'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aimiaobi.cn-beijing.aliyuncs.com', 'endpoint' => 'aimiaobi.cn-beijing.aliyuncs.com', 'vpc' => 'aimiaobi-vpc.cn-beijing.aliyuncs.com'],
+ ],
+ 'errorCodes' => [
+ ['code' => 'AccessForbid', 'message' => 'Access forbid.', 'http_code' => 403, 'description' => '无权限访问当前接口或资源'],
+ ['code' => 'Forbidden', 'message' => 'no permission to access action.', 'http_code' => 403, 'description' => '当前账号无权限操作workspaceId对应业务空间,请使用有权限的账号前往百炼控制台给当前账号授权'],
+ ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action.', 'http_code' => 403, 'description' => '请检查workspaceId的赋值'],
+ ],
+ 'changeSet' => [
[
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'aimiaobi.cn-beijing.aliyuncs.com',
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'RunSearchGeneration'],
+ ],
+ 'createdAt' => '2025-11-12T02:51:11.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'AddAuditTerms'],
+ ['description' => '请求参数发生变更', 'api' => 'DeleteAuditNote'],
+ ['description' => '请求参数发生变更', 'api' => 'DownloadAuditNote'],
+ ['description' => '请求参数发生变更', 'api' => 'GetAvailableAuditNotes'],
+ ['description' => '请求参数发生变更、响应参数发生变更', 'api' => 'ListAuditTerms'],
+ ['description' => '请求参数发生变更', 'api' => 'SubmitAuditNote'],
+ ['description' => '请求参数发生变更', 'api' => 'SubmitExportTermsTask'],
+ ['description' => '请求参数发生变更', 'api' => 'SubmitImportTermsTask'],
+ ['description' => '请求参数发生变更', 'api' => 'SubmitSmartAudit'],
+ ],
+ 'createdAt' => '2025-11-11T11:58:58.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'SearchNews'],
+ ],
+ 'createdAt' => '2024-05-29T08:39:52.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'GenerateFileUrlByKey'],
+ ['description' => '请求参数发生变更', 'api' => 'GenerateUploadConfig'],
+ ],
+ 'createdAt' => '2024-03-04T09:44:20.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [
+ ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAsyncTask'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FeedbackDialogue'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FetchImageTask'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListGeneratedContents'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveMaterialDocument'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAsyncTasks'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateMaterialDocument'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateViewPoint'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateToken'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDialogues'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListVersions'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListMaterialDocuments'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateUploadConfig'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListHotNewsWithType'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListBuildConfigs'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMaterialById'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportGeneratedContent'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveDataSourceOrderConfig'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetProperties'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateImageTask'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteGeneratedContent'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteMaterialById'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateGeneratedContent'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitAsyncTask'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateFileUrlByKey'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SearchNews'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGeneratedContent'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDataSourceOrderConfig'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAsyncTask'],
+ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetGeneratedContent'],
+ ],
+ ],
+ 'ram' => [
+ 'productCode' => 'AiMiaoBi',
+ 'productName' => '大模型服务平台百炼',
+ 'ramCodes' => ['aimiaobi'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'RunDocTranslation',
+ 'description' => '文档翻译',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocTranslation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunWriting',
+ 'description' => '直接写作',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAuditNote',
+ 'description' => '删除规则库',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InitiatePptCreationV2',
+ 'description' => '初始化PPT创建操作',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InitiatePptCreationV2',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitImportTermsTask',
+ 'description' => '提交导入词库任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitImportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTopicViewPointRecommendEventList',
+ 'description' => '获取热点事件推荐观点列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListTopicViewPointRecommendEventList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SearchDatasetDocuments',
+ 'description' => '数据源-搜索文档',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SearchDatasetDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunGenerateQuestions',
+ 'description' => '猜你想问',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunGenerateQuestions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAutoClipsTaskInfo',
+ 'description' => '获得剪辑任务信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAutoClipsTaskInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunStyleFeatureAnalysis',
+ 'description' => '内容特点分析',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunStyleFeatureAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateExportWordTask',
+ 'description' => '生成导出文档任务',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateExportWordTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunCustomHotTopicViewPointAnalysis',
+ 'description' => '自定义选题视角分析',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunCustomHotTopicViewPointAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGeneratedContent',
+ 'description' => '删除文档',
+ 'operationType' => 'delete',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AsyncUploadVideo',
+ 'description' => '异步上传视频剪辑素材',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncUploadVideo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AsyncCreateClipsTimeLine',
+ 'description' => '创建剪辑口播时间线',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncCreateClipsTimeLine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCustomSourceTopicAnalysisTask',
+ 'description' => '获取自定义源话题分析任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomSourceTopicAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListMaterialDocuments',
+ 'description' => '获取素材列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListMaterialDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitCustomSourceTopicAnalysis',
+ 'description' => '提交自定义源话题选题分析任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitCustomSourceTopicAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInterveneGlobalReply',
+ 'description' => '获得干预全局回复内容',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneGlobalReply',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddAuditTerms',
+ 'description' => '添加自定义词库记录',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AddAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDocs',
+ 'description' => '获取文档列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDocs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPptConfig',
+ 'description' => '获取PPT组件配置',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAuditContentErrorTypes',
+ 'description' => '获取审校维度列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAuditContentErrorTypes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDatasetDocuments',
+ 'description' => '数据源-文档列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDatasetDocuments',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteInterveneRule',
+ 'description' => '删除干预规则',
+ 'operationType' => 'delete',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteInterveneRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListBiddingDoc',
+ 'description' => '列出标书写作任务',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSmartAuditResult',
+ 'description' => '查询智能审校结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetSmartAuditResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataset',
+ 'description' => '数据源-创建',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateViewPoint',
+ 'description' => '生成选题视角(已过时,不推荐使用)',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateViewPoint',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunSearchSimilarArticles',
+ 'description' => '妙搜-文搜文',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunSearchSimilarArticles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDatasetDocument',
+ 'description' => '数据源-获取文档详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InsertInterveneRule',
+ 'description' => '插入干预规则',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InsertInterveneRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AsyncUploadTenderDoc',
+ 'description' => '招标文档解析',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncUploadTenderDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunCommentGeneration',
+ 'description' => '客户之声预测',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunCommentGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateGeneratedContent',
+ 'description' => '更新文档',
+ 'operationType' => 'update',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ClearIntervenes',
+ 'description' => '清除所有干预项',
+ 'operationType' => 'delete',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ClearIntervenes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DownloadAuditNote',
+ 'description' => '下载规则库',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DownloadAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDataPermissions',
+ 'description' => '权限-列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDataPermissions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListHotTopics',
+ 'description' => '获取热点话题列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotTopics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDocSmartCard',
+ 'description' => '文档智能卡片',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocSmartCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDocSummary',
+ 'description' => '文档摘要',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocSummary',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataSourceOrderConfig',
+ 'description' => '获取信源配置权重数据',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDataSourceOrderConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelDeepWriteTask',
+ 'description' => '取消深度写作任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CancelDeepWriteTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInterveneRules',
+ 'description' => '列出干预规则',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListInterveneRules',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveOrUpdateOssConfig',
+ 'description' => '配置-云存储-参数配置',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveOrUpdateOssConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitCustomTopicSelectionPerspectiveAnalysisTask',
+ 'description' => '提交自定义热点选题视角分析任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitCustomTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWebReviewPoints',
+ 'description' => '获取网友视角列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListWebReviewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDocIntroduction',
+ 'description' => '文档导读',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocIntroduction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DocumentExtraction',
+ 'description' => '文档提取',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DocumentExtraction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteAuditTerms',
+ 'description' => '删除指定词库记录',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FeedbackDialogue',
+ 'description' => '反馈对话',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FeedbackDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateMaterialDocument',
+ 'description' => '更新素材',
+ 'operationType' => 'update',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateMaterialDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomTopicByTopic',
+ 'description' => '删除自定义热点事件',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteCustomTopicByTopic',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDocWashing',
+ 'description' => '改写',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocWashing',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetClipsBuildInResource',
+ 'description' => '获取智能混剪内置资源',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetClipsBuildInResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeletePptArtifact',
+ 'description' => '删除PPT作品',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeletePptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCategoriesByTaskId',
+ 'description' => '根据任务ID获取分类列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCategoriesByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateGeneralConfig',
+ 'description' => '通用配置-创建',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveMaterialDocument',
+ 'description' => '保存素材',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveMaterialDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AsyncEditTimeline',
+ 'description' => '编辑剪辑口播时间线',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncEditTimeline',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCustomText',
+ 'description' => '获取自定义文本列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListFreshViewPoints',
+ 'description' => '获取新颖视角列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListFreshViewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListWritingStyles',
+ 'description' => '获取写作文体列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListWritingStyles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitCustomHotTopicBroadcastJob',
+ 'description' => '提交自定义播报单任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitCustomHotTopicBroadcastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitTopicSelectionPerspectiveAnalysisTask',
+ 'description' => '提交选题热点分析任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataset',
+ 'description' => '数据源-删除',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDeepWriteTask',
+ 'description' => '查询深度写作任务',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDeepWriteTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetEnterpriseVocAnalysisTask',
+ 'description' => '获取企业VOC挖掘任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateToken',
+ 'description' => '获取授权token',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportAnalysisTagDetailByTaskId',
+ 'description' => '导出标签挖掘结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDeepWriting',
+ 'description' => '查询深度写作事件',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDeepWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSearchTasks',
+ 'description' => '查询妙搜搜索生成历史任务列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListSearchTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListStyleLearningResult',
+ 'description' => '获取文体学习分析结果列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInterveneImportTaskInfo',
+ 'description' => '获得干预项目导入任务信息',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneImportTaskInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunHotword',
+ 'description' => '抽取关键词',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunHotword',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListGeneratedContents',
+ 'description' => '获取文档列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListGeneratedContents',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelAsyncTask',
+ 'description' => '取消异步任务',
+ 'operationType' => 'update',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CancelAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryAsyncTask',
+ 'description' => '查询异步任务明细',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:QueryAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ImportInterveneFileAsync',
+ 'description' => '异步导入干预项文件',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ImportInterveneFileAsync',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetSmartClipTask',
+ 'description' => '获取智能剪辑任务结果',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetSmartClipTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportHotTopicPlanningProposals',
+ 'description' => '导出选题策划文档',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportHotTopicPlanningProposals',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunPptOutlineGeneration',
+ 'description' => '生成PPT大纲内容',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunPptOutlineGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListHotViewPoints',
+ 'description' => '获取热门视角列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotViewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateCustomText',
+ 'description' => '更新自定义文本',
+ 'operationType' => 'update',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateImageTask',
+ 'description' => '生成智能配图任务',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateImageTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryAuditTask',
+ 'description' => '查询审核结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:QueryAuditTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomText',
+ 'description' => '删除自定义文本',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunKeywordsExtractionGeneration',
+ 'description' => '关键词抽取',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunKeywordsExtractionGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateGeneratedContent',
+ 'description' => '保存文档',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ImportInterveneFile',
+ 'description' => '同步导入干预项文件',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ImportInterveneFile',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDialogues',
+ 'description' => '生成历史列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDialogues',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetGeneratedContent',
+ 'description' => '获取文档',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListHotNewsWithType',
+ 'description' => '获取选题热点列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotNewsWithType',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitEnterpriseVocAnalysisTask',
+ 'description' => '提交企业VOC分析任务',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitEnterpriseVocAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunBookBrainmap',
+ 'description' => '书籍脑图',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunBookBrainmap',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDocs',
+ 'description' => '批量删除文档',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDocs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTopicById',
+ 'description' => '获取热点对象',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetTopicById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunTranslateGeneration',
+ 'description' => '中英翻译',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTranslateGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunQuickWriting',
+ 'description' => '快速写作',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunQuickWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InsertInterveneGlobalReply',
+ 'description' => '插入干预全局回复项',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InsertInterveneGlobalReply',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteCustomTopicViewPointById',
+ 'description' => '删除自定义选题视角',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteCustomTopicViewPointById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunTopicSelectionMerge',
+ 'description' => '选题热点融合',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTopicSelectionMerge',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSearchTaskDialogues',
+ 'description' => '查询妙搜搜索生成任务详情列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListSearchTaskDialogues',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AddDatasetDocument',
+ 'description' => '数据源-添加文档到数据集',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AddDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDatasetDocument',
+ 'description' => '数据源-删除数据集文档',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetHotTopicBroadcast',
+ 'description' => '查询完整播报单(热榜)',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetHotTopicBroadcast',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitVideoAudit',
+ 'description' => '提交视频审校任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitVideoAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAuditTerms',
+ 'description' => '获取自定义词库记录',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunAiHelperWriting',
+ 'description' => 'AI帮写',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunAiHelperWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveStyleLearningResult',
+ 'description' => '保存文体学习分析结果',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveDataSourceOrderConfig',
+ 'description' => '保存信源权重配置',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveDataSourceOrderConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListCustomViewPoints',
+ 'description' => '获取自定义视角列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListCustomViewPoints',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunTextPolishing',
+ 'description' => '润色',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTextPolishing',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetProperties',
+ 'description' => '获取配置信息',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetProperties',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTopicSelectionPerspectiveAnalysisTask',
+ 'description' => '获取选题视角分析任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListEnterprisePptTemplates',
+ 'description' => '查询企业专属PPT模板列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListEnterprisePptTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchExportWordTask',
+ 'description' => '获取导出文档任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchExportWordTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAutoClipsTask',
+ 'description' => '智能混剪任务列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAutoClipsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPptArtifacts',
+ 'description' => '查询PPT作品列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListPptArtifacts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadBook',
+ 'description' => '书籍上传',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UploadBook',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTopicRecommendEventList',
+ 'description' => '获取热点推荐事件列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListTopicRecommendEventList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDataset',
+ 'description' => '数据源-详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListIntervenes',
+ 'description' => '列出干预项',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListIntervenes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateFileUrlByKey',
+ 'description' => '生成文件URL',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateFileUrlByKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EditAuditTerms',
+ 'description' => '编辑自定义词库记录',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:EditAuditTerms',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCustomHotTopicBroadcastJob',
+ 'description' => '获取自定义播报单任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomHotTopicBroadcastJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchImageTask',
+ 'description' => '获取图片任务执行结果',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchImageTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPptArtifact',
+ 'description' => '查询PPT作品信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunWriteToneGeneration',
+ 'description' => '文风改写',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunWriteToneGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryVideoAuditResult',
+ 'description' => '查询视频审校结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:QueryVideoAuditResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPptInfo',
+ 'description' => '查询PPT任务信息',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunAbbreviationContent',
+ 'description' => '内容缩写',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunAbbreviationContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteMaterialById',
+ 'description' => '删除素材',
+ 'operationType' => 'delete',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteMaterialById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateDataPermissions',
+ 'description' => '权限-批量添加',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CreateDataPermissions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitSmartClipTask',
+ 'description' => '提交智能一键成片任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitSmartClipTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPlanningProposal',
+ 'description' => '获取选题策划列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListPlanningProposal',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunStepByStepWriting',
+ 'description' => '分步骤写作',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunStepByStepWriting',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInterveneRuleDetail',
+ 'description' => '获得干预规则的详情',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneRuleDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCustomText',
+ 'description' => '获取自定义文本',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunSummaryGenerate',
+ 'description' => '摘要生成',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunSummaryGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UploadDoc',
+ 'description' => '文档上传',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UploadDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunCustomHotTopicAnalysis',
+ 'description' => '自定义热点话题分析',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunCustomHotTopicAnalysis',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateGeneralConfig',
+ 'description' => '通用配置-修改',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunBookIntroduction',
+ 'description' => '书籍导读(抽取书籍卖点/书籍摘要)',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunBookIntroduction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AsyncCreateClipsTask',
+ 'description' => '创建剪辑任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncCreateClipsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitSmartAudit',
+ 'description' => '提交智能审校任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitSmartAudit',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'BindPptArtifact',
+ 'description' => '绑定PPT作品信息',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:BindPptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportIntervenes',
+ 'description' => '导出干预项内容',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportIntervenes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SaveCustomText',
+ 'description' => '保存自定义文本',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SaveCustomText',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListVersions',
+ 'description' => '获取版本信息',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListVersions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPptArtifactExportResult',
+ 'description' => '查询PPT导出任务的结果',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptArtifactExportResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListSearchTaskDialogueDatas',
+ 'description' => '查询搜索生成任务对话详情中数据列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListSearchTaskDialogueDatas',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ValidateUploadTemplate',
+ 'description' => '校验VOC上传模板',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ValidateUploadTemplate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListInterveneCnt',
+ 'description' => '获得所有干预项的数量',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListInterveneCnt',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFactAuditUrl',
+ 'description' => '获取事实性审核 URL',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetFactAuditUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunWritingV2',
+ 'description' => '智能写作',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunWritingV2',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDatasets',
+ 'description' => '数据源-列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDatasets',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunSearchGeneration',
+ 'description' => '妙搜-智能搜索',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunSearchGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitDeepWriteTask',
+ 'description' => '提交深度写作任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitDeepWriteTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitAuditNote',
+ 'description' => '提交自定义规则库',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetBiddingRemainLimitNum',
+ 'description' => '获得标书写作剩余额度',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetBiddingRemainLimitNum',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportCustomSourceAnalysisTask',
+ 'description' => '导出自定义源-话题分析任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportCustomSourceAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDocClusterTask',
+ 'description' => '获取内容聚合任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDocClusterTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunVideoScriptGenerate',
+ 'description' => 'AI生成视频剪辑脚本',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunVideoScriptGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListHotSources',
+ 'description' => '获取三方热榜源列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListHotSources',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAnalysisTagDetailByTaskId',
+ 'description' => '根据任务ID获取标签分析明细列表',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAnalysisTagDetailByTaskId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListDocumentRetrieve',
+ 'description' => '公文库检索',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListDocumentRetrieve',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListBuildConfigs',
+ 'description' => '获取系统自定义预设',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListBuildConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetCustomTopicSelectionPerspectiveAnalysisTask',
+ 'description' => '获取自定义选题视角分析任务结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetCustomTopicSelectionPerspectiveAnalysisTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitExportTermsTask',
+ 'description' => ' 提交导出词库任务',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitExportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DownloadBiddingDoc',
+ 'description' => '下载标书文件',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DownloadBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunBookSmartCard',
+ 'description' => '书籍智能卡片',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunBookSmartCard',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListPptTemplates',
+ 'description' => '查询PPT模板列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListPptTemplates',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteStyleLearningResult',
+ 'description' => '删除自定义文体',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AsyncWritingBiddingDoc',
+ 'description' => '标书写作',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:AsyncWritingBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'InitiatePptCreation',
+ 'description' => '初始化用来创建PPT的会话',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:InitiatePptCreation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAvailableAuditNotes',
+ 'description' => '查询可用规则库',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAvailableAuditNotes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDeepWriteTaskResult',
+ 'description' => '查询深度写作任务的结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDeepWriteTaskResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportPptArtifact',
+ 'description' => '导出PPT作品',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportPptArtifact',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetGeneralConfig',
+ 'description' => '通用配置-详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDataset',
+ 'description' => '数据源-修改',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateDataset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetInterveneTemplateFileUrl',
+ 'description' => '获得干预导入模版文件地址',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetInterveneTemplateFileUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetStyleLearningResult',
+ 'description' => '获取文体学习分析结果',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetStyleLearningResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTimedViewAttitude',
+ 'description' => '获取时效性视角列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListTimedViewAttitude',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchExportTermsTask',
+ 'description' => '获取导出词库任务结果',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchExportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAuditNoteProcessingStatus',
+ 'description' => '查询规则库上传状态',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAuditNoteProcessingStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteDataPermissions',
+ 'description' => '权限-删除',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteDataPermissions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunContinueContent',
+ 'description' => '内容续写',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunContinueContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'FetchImportTermsTask',
+ 'description' => '获取导入词库任务结果',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:FetchImportTermsTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAuditNotePostProcessingStatus',
+ 'description' => '获取规则库后处理进度',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetAuditNotePostProcessingStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetBiddingDocInfo',
+ 'description' => '获得标书写作结果',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetBiddingDocInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDocBrainmap',
+ 'description' => '全文脑图',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocBrainmap',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListGeneralConfigs',
+ 'description' => '通用配置-列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListGeneralConfigs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateDatasetDocument',
+ 'description' => '数据源-修改文档',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:UpdateDatasetDocument',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetDocInfo',
+ 'description' => '获取文档信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetDocInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitAsyncTask',
+ 'description' => '提交异步任务',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitAsyncTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunMultiDocIntroduction',
+ 'description' => '多文档聚合摘要',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunMultiDocIntroduction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListAsyncTasks',
+ 'description' => '获取异步任务列表',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ListAsyncTasks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunTitleGeneration',
+ 'description' => '标题生成',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunTitleGeneration',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GenerateUploadConfig',
+ 'description' => '生成上传配置',
+ 'operationType' => 'create',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GenerateUploadConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetMaterialById',
+ 'description' => '获取素材',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetMaterialById',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ConfirmAndPostProcessAuditNote',
+ 'description' => '确认提交规则库用于审核',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ConfirmAndPostProcessAuditNote',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitDocClusterTask',
+ 'description' => '提交内容聚合任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitDocClusterTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetPptTemplateSelector',
+ 'description' => '查询PPT模板筛选器',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetPptTemplateSelector',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunExpandContent',
+ 'description' => '内容扩写',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunExpandContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetFileContentLength',
+ 'description' => '获取文件长度',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:GetFileContentLength',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CancelAuditTask',
+ 'description' => '取消审核任务',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:CancelAuditTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportGeneratedContent',
+ 'description' => '导出文档',
+ 'operationType' => 'get',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportGeneratedContent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'RunDocQa',
+ 'description' => '文档问答(文章问答/多模态文件问答)',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:RunDocQa',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'EditBiddingDoc',
+ 'description' => '编辑标书内容',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:EditBiddingDoc',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitAuditTask',
+ 'description' => '提交审核任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitAuditTask',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteGeneralConfig',
+ 'description' => '通用配置-删除',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteGeneralConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SearchNews',
+ 'description' => '信息检索',
+ 'operationType' => 'list',
+ 'additionalActions' => [],
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SearchNews',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'DeleteFactAuditUrl',
+ 'description' => '删除事实性审核 URL',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:DeleteFactAuditUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExportAuditContentResult',
+ 'description' => '导出智能审校报告',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:ExportAuditContentResult',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'SubmitFactAuditUrl',
+ 'description' => '提交事实性审核 URL',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aimiaobi:SubmitFactAuditUrl',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'resourceTypes' => [],
],
];