'1.0', 'info' => ['style' => 'RPC', 'product' => 'AiMiaoBi', 'version' => '2023-08-01'], 'directories' => [ [ 'children' => ['CreateToken', 'ListDialogues', 'ListVersions', 'GetProperties'], 'type' => 'directory', 'title' => 'Common operations', ], [ 'children' => ['GenerateFileUrlByKey', 'GenerateUploadConfig'], 'type' => 'directory', 'title' => 'Common operations - file upload and download', ], [ 'children' => ['SubmitAsyncTask', 'CancelAsyncTask', 'QueryAsyncTask', 'ListAsyncTasks'], 'type' => 'directory', 'title' => 'Common operations - asynchronous task management', ], [ 'children' => ['CreateGeneralConfig', 'ListGeneralConfigs', 'GetGeneralConfig', 'UpdateGeneralConfig', 'DeleteGeneralConfig'], 'type' => 'directory', 'title' => 'Common operations - general configuration', ], [ 'children' => ['RunAiHelperWriting', 'RunWritingV2', 'RunWriting', 'RunStepByStepWriting', 'RunTranslateGeneration', 'RunTextPolishing', 'RunKeywordsExtractionGeneration', 'RunContinueContent', 'RunWriteToneGeneration', 'RunTitleGeneration', 'RunSummaryGenerate', 'RunExpandContent', 'RunAbbreviationContent', 'SearchNews', 'RunQuickWriting', 'ListBuildConfigs', 'GenerateImageTask', 'FetchImageTask', 'FeedbackDialogue'], 'type' => 'directory', 'title' => 'AMB - article creation', ], [ 'children' => ['ListStyleLearningResult', 'RunStyleFeatureAnalysis', 'SaveStyleLearningResult', 'DeleteStyleLearningResult', 'GetStyleLearningResult', 'ListWritingStyles'], 'type' => 'directory', 'title' => 'AMB - style imitation', ], [ 'children' => ['SubmitVideoAudit', 'QueryVideoAuditResult'], 'type' => 'directory', 'title' => 'AMB - video proofreading', ], [ 'children' => ['SubmitAuditNote', 'ConfirmAndPostProcessAuditNote', 'DownloadAuditNote', 'DeleteAuditNote', 'GetAuditNotePostProcessingStatus', 'GetAuditNoteProcessingStatus', 'GetAvailableAuditNotes'], 'type' => 'directory', 'title' => 'AMB - article proofreading - rule library management', ], [ 'children' => ['ListAuditTerms', 'AddAuditTerms', 'EditAuditTerms', 'DeleteAuditTerms', 'SubmitImportTermsTask', 'FetchImportTermsTask', 'SubmitExportTermsTask', 'FetchExportTermsTask'], 'type' => 'directory', 'title' => 'AMB - article proofreading - lexicon management', ], [ 'children' => ['SubmitFactAuditUrl', 'GetFactAuditUrl', 'DeleteFactAuditUrl'], 'type' => 'directory', 'title' => 'AMB - article proofreading - factual review', ], [ 'children' => ['QueryAuditTask', 'SubmitAuditTask', 'CancelAuditTask', 'SubmitSmartAudit', 'GetSmartAuditResult', 'ListAuditContentErrorTypes', 'ExportAuditContentResult'], 'type' => 'directory', 'title' => 'AMB - article proofreading', ], [ 'children' => ['GenerateExportWordTask', 'FetchExportWordTask', 'CreateGeneratedContent', 'DeleteGeneratedContent', 'UpdateGeneratedContent', 'GetGeneratedContent', 'ListGeneratedContents', 'ExportGeneratedContent'], 'type' => 'directory', 'title' => 'AMB - document management', ], [ 'children' => ['SaveMaterialDocument', 'DeleteMaterialById', 'UpdateMaterialDocument', 'GetMaterialById', 'ListMaterialDocuments'], 'type' => 'directory', 'title' => 'AMB - material library', ], [ 'children' => ['GetCustomText', 'UpdateCustomText', 'ListCustomText', 'SaveCustomText', 'DeleteCustomText', 'DocumentExtraction'], 'type' => 'directory', 'title' => 'AMB - material library - custom text', ], [ 'children' => ['GetClipsBuildInResource', 'AsyncCreateClipsTimeLine', 'AsyncEditTimeline', 'AsyncUploadVideo', 'GetAutoClipsTaskInfo', 'AsyncCreateClipsTask', 'ListAutoClipsTask'], 'type' => 'directory', 'title' => 'AMB - video mashup', ], [ 'children' => ['SubmitCustomSourceTopicAnalysis', 'GetCustomSourceTopicAnalysisTask', 'ExportCustomSourceAnalysisTask'], 'type' => 'directory', 'title' => 'Smart strategy - custom data source', ], [ 'children' => ['ListDocumentRetrieve'], 'type' => 'directory', 'title' => 'Official document retrieval', ], [ 'children' => ['RunTopicSelectionMerge', 'ListHotNewsWithType', 'ListHotSources', 'ListHotTopics', 'GetTopicById', 'ListHotViewPoints', 'ListTimedViewAttitude', 'ListFreshViewPoints', 'ListWebReviewPoints', 'ListPlanningProposal', 'ExportHotTopicPlanningProposals'], 'type' => 'directory', 'title' => 'Smart strategy - trending topics', ], [ 'children' => ['DeleteCustomTopicByTopic', 'ListTopicViewPointRecommendEventList', 'ListTopicRecommendEventList', 'RunCustomHotTopicAnalysis', 'RunCustomHotTopicViewPointAnalysis', 'ListCustomViewPoints', 'DeleteCustomTopicViewPointById'], 'type' => 'directory', 'title' => 'Smart strategy - custom topics', ], [ 'children' => ['SubmitDocClusterTask', 'GetDocClusterTask', 'SubmitTopicSelectionPerspectiveAnalysisTask', 'GetTopicSelectionPerspectiveAnalysisTask', 'SubmitCustomTopicSelectionPerspectiveAnalysisTask', 'GetCustomTopicSelectionPerspectiveAnalysisTask'], 'type' => 'directory', 'title' => 'Smart strategy - openAPI', ], [ 'children' => ['GetHotTopicBroadcast', 'SubmitCustomHotTopicBroadcastJob', 'GetCustomHotTopicBroadcastJob'], 'type' => 'directory', 'title' => 'Smart strategy - news broadcast', ], [ 'children' => ['ExportAnalysisTagDetailByTaskId', 'ValidateUploadTemplate', 'SubmitEnterpriseVocAnalysisTask', 'ListAnalysisTagDetailByTaskId', 'GetEnterpriseVocAnalysisTask', 'GetCategoriesByTaskId'], 'type' => 'directory', 'title' => 'Smart strategy - enterprise VOC mining', ], [ 'children' => ['AddDatasetDocument', 'GetDatasetDocument', 'UpdateDatasetDocument', 'ListDatasetDocuments', 'SearchDatasetDocuments', 'DeleteDatasetDocument'], 'type' => 'directory', 'title' => 'Smart search - data source', ], [ 'children' => ['RunSearchGeneration', 'ListSearchTasks', 'ListSearchTaskDialogues', 'ListSearchTaskDialogueDatas', 'RunSearchSimilarArticles'], 'type' => 'directory', 'title' => 'Smart search - intelligent search', ], [ 'children' => ['ListInterveneCnt', 'ListIntervenes', 'ImportInterveneFile', 'InsertInterveneGlobalReply', 'ImportInterveneFileAsync', 'GetInterveneTemplateFileUrl', 'ClearIntervenes', 'GetInterveneGlobalReply', 'ListInterveneRules', 'ListInterveneImportTasks', 'InsertInterveneRule', 'GetInterveneRuleDetail', 'DeleteInterveneRule', 'ExportIntervenes', 'GetInterveneImportTaskInfo'], 'type' => 'directory', 'title' => 'System configuration - intervention configuration', ], [ 'children' => ['SaveDataSourceOrderConfig', 'GetDataSourceOrderConfig'], 'type' => 'directory', 'title' => 'System configuration - source management', ], [ 'children' => ['GetDocInfo', 'GetFileContentLength', 'UploadBook', 'UploadDoc', 'ListDocs', 'DeleteDocs'], 'type' => 'directory', 'title' => 'Smart reading - basic operations', ], [ 'children' => ['RunMultiDocIntroduction', 'RunDocBrainmap', 'RunDocIntroduction', 'RunDocSummary', 'RunDocWashing', 'RunBookIntroduction', 'RunBookBrainmap', 'RunCommentGeneration'], 'type' => 'directory', 'title' => 'Smart reading - generation', ], [ 'children' => ['RunHotword'], 'type' => 'directory', 'title' => 'Smart reading - extraction', ], [ 'children' => ['RunGenerateQuestions', 'RunDocQa'], 'type' => 'directory', 'title' => 'Smart reading - Q&A', ], [ 'children' => ['RunDocTranslation', 'RunDocSmartCard', 'RunBookSmartCard'], 'type' => 'directory', 'title' => 'Smart reading - others', ], [ 'children' => ['SubmitDeepWriteTask', 'GetDeepWriteTask', 'GetDeepWriteTaskResult', 'CancelDeepWriteTask', 'RunDeepWriting'], 'type' => 'directory', 'title' => 'Deep writing', ], [ 'children' => ['ListEnterprisePptTemplates', 'InitiatePptCreationV2', 'ListPptTemplates', 'GetPptTemplateSelector', 'GetPptArtifactExportResult', 'ExportPptArtifact', 'GetPptArtifact', 'ListPptArtifacts', 'RunPptOutlineGeneration', 'InitiatePptCreation', 'GetPptConfig', 'BindPptArtifact', 'DeletePptArtifact'], 'type' => 'directory', 'title' => 'PPT generation', ], [ 'children' => ['AsyncUploadTenderDoc', 'GetBiddingRemainLimitNum', 'GetBiddingDocInfo', 'EditBiddingDoc', 'DownloadBiddingDoc', 'AsyncWritingBiddingDoc', 'ListBiddingDoc'], 'type' => 'directory', 'title' => 'Bid document generation', ], [ 'children' => ['RunVideoScriptGenerate', 'GetSmartClipTask', 'SubmitSmartClipTask', 'SaveOrUpdateOssConfig', 'CreateDataPermissions', 'DeleteDataPermissions', 'ListDataPermissions', 'GenerateViewPoint', 'CreateDataset', 'DeleteDataset', 'FetchParseDocumentLayoutTask', 'GetDataset', 'GetPptInfo', 'ListDatasets', 'SubmitParseDocumentLayoutTask', 'UpdateDataset'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'GenerateTraceability' => [ 'title' => '', 'description' => 'The traceability object.', 'type' => 'object', 'properties' => [ 'News' => [ 'title' => '', 'description' => 'The list of traceability news.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The traceability news object.', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The URL.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'."\n"], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '新闻标题'], 'PubTime' => ['title' => '', 'description' => 'The publish time.', 'type' => 'string', 'example' => '2024-01-22 10:29:00'], 'SearchSourceName' => ['title' => '', 'description' => 'The name of the retrieval source.', 'type' => 'string', 'example' => '检索源编码'."\n" ."\n"], 'SearchSource' => ['title' => '', 'description' => 'The unique identity of the retrieval source.', 'type' => 'string', 'example' => '检索源唯一标识'], 'Index' => ['title' => '', 'description' => 'The index \\`n\\` that corresponds to the \\`\\[\\[n]]\\` marker in the original article. The index starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'HottopicNews' => [ 'description' => 'News object', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['description' => 'News title ', 'title' => '', 'type' => 'string', 'example' => '新闻标题xxx'], 'Content' => ['description' => 'News content ', 'title' => '', 'type' => 'string', 'example' => '新闻内容xxx'], 'Url' => ['description' => 'News URL link ', 'title' => '', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'], 'Comments' => [ 'description' => 'List of news comments ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'News comment object ', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'News comment content ', 'title' => '', 'type' => 'string', 'example' => '新闻评论内容'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'OutlineSearchResult' => [ 'title' => '', 'description' => 'Outline retrieval result.', 'type' => 'object', 'properties' => [ 'Query' => ['title' => '', 'description' => 'The retrieval query.', 'type' => 'string', 'example' => '高校环保义卖案例 大学生旧物循环利用率的文章'], 'Outline' => ['title' => '', 'description' => 'The retrieved outline.', 'type' => 'string', 'example' => '晨光中的自律：清晨6:30的校园'], 'OutlineId' => ['title' => '', 'description' => 'The unique identifier of the outline.', 'type' => 'string', 'example' => 'xxxxxx'], 'PrimaryOutline' => ['title' => '', 'description' => 'The primary outline.', 'type' => 'string', 'example' => '大学生正能量的一天'], 'Articles' => [ 'title' => '', 'description' => 'A list of retrieved materials.', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A retrieved material.', '$ref' => '#/components/schemas/OutlineWritingArticle', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'OutlineWritingArticle' => [ 'title' => '', 'description' => 'News or material object', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'News URL', 'type' => 'string', 'example' => 'http://www.example.com/xxxx.html'], 'Title' => ['title' => '', 'description' => 'News title', 'type' => 'string', 'example' => '新闻标题'], 'Content' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'example' => '新闻内容'], 'SearchSource' => ['title' => '', 'description' => 'Retrieval source encoding', 'type' => 'string', 'example' => '检索源编码'], 'SearchSourceName' => ['title' => '', 'description' => 'Retrieval name', 'type' => 'string', 'example' => '检索源名称'], 'PubTime' => ['title' => '', 'description' => 'Publish time', 'type' => 'string', 'example' => '2023-04-11 06:14:07'], 'PrimaryOutline' => ['title' => '', 'description' => 'The primary outline this material belongs to', 'type' => 'string', 'example' => '一级大纲名称'], 'Outline' => ['title' => '', 'description' => 'The leaf outline this material belongs to', 'type' => 'string', 'example' => '大纲名称'], ], 'example' => '', ], 'TopicSelection' => [ 'title' => '', 'description' => 'The topic selection object.', 'type' => 'object', 'properties' => [ 'Point' => ['title' => '', 'description' => 'The perspective of the topic.', 'type' => 'string', 'example' => '选题视角'."\n" ."\n"], 'Summary' => ['title' => '', 'description' => 'The summary of the topic.', 'type' => 'string', 'example' => '摘要'], 'Outlines' => [ 'title' => '', 'description' => 'A list of topic outlines.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'A topic outline object.', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The topic outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'The summary of the outline.', 'type' => 'string', 'example' => '摘要'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'WritingOutline' => [ 'title' => '', 'description' => 'Writing outline', 'type' => 'object', 'properties' => [ 'WritingTips' => ['title' => '', 'description' => 'Outline writing requirements, writing tips', 'type' => 'string', 'example' => '大纲写作要求、写作提示'], 'OutlineId' => ['title' => '', 'description' => 'Unique outline identifier', 'type' => 'string', 'example' => 'xxx'], 'Outline' => ['title' => '', 'description' => 'Outline', 'type' => 'string', 'example' => '大纲名称'], 'SearchKeyWordList' => [ 'title' => '', 'description' => 'Outline writing search keyword list', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Outline writing search keyword', 'type' => 'string', 'example' => '检索关键词'], 'example' => '', ], 'WordCount' => ['title' => '', 'description' => 'Description of word count requirements, such as 1K words, 2K words, or no less than 500 words.', 'type' => 'string', 'example' => '写作字数要求的描述'], 'Articles' => [ 'description' => 'List of articles referenced in the outline', 'type' => 'array', 'items' => ['description' => 'Article referenced in the outline', '$ref' => '#/components/schemas/OutlineWritingArticle', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], 'Children' => [ 'title' => '', 'description' => 'List of sub-outlines', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Sub-outline', '$ref' => '#/components/schemas/WritingOutline', 'example' => ''], 'example' => '', ], ], 'example' => '', ], 'WritingStyleTemplateDefine' => [ 'title' => '写作文体模板定义', 'type' => 'object', 'properties' => [ 'Fields' => [ 'title' => '模板表单列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/WritingStyleTemplateField'], ], 'Example' => [ 'title' => '表单的示例', 'type' => 'array', 'items' => [ 'title' => '表单对象', 'type' => 'object', 'properties' => [ 'Value' => ['title' => '表单值', 'type' => 'string'], 'Key' => ['title' => '表单KEY', 'type' => 'string'], ], ], ], ], ], 'WritingStyleTemplateField' => [ 'title' => '写作文体表单字段定义', 'type' => 'object', 'properties' => [ 'MinItemLength' => ['title' => '数组内每个元素的最小长度', 'type' => 'integer', 'format' => 'int32'], 'Max' => ['title' => '数值输入的最大值', 'type' => 'number', 'format' => 'double'], 'MinLength' => ['title' => '字符输入最小长度', 'type' => 'integer', 'format' => 'int32'], 'MaxLength' => ['title' => '字符输入最大长度', 'type' => 'integer', 'format' => 'int32'], 'MaxItemLength' => ['title' => '数组内每个元素的最大长度', 'type' => 'integer', 'format' => 'int32'], 'Name' => ['title' => '表单名称', 'type' => 'string'], 'BuildIn' => ['title' => '是否为内置字段', 'type' => 'boolean'], 'Enums' => [ 'title' => '表单的枚举值列表', 'type' => 'array', 'items' => [ 'title' => '枚举对象', 'type' => 'object', 'properties' => [ 'CascadingFields' => [ 'title' => '级联字段列表（详情参考 通知文体的定义）', 'type' => 'array', 'items' => ['title' => '级联字段', 'type' => 'string'], ], 'Key' => ['title' => '枚举的唯一KEY', 'type' => 'string'], 'Name' => ['title' => '枚举的名称', 'type' => 'string'], ], ], ], 'Min' => ['title' => '数值输入的最小值', 'type' => 'number', 'format' => 'double'], 'Required' => ['title' => '该表单是否必填', 'type' => 'boolean'], 'MaxItem' => ['title' => '数组的元素最大个数', 'type' => 'integer', 'format' => 'int32'], 'InitialValue' => ['title' => '初始化值', 'type' => 'string'], 'CascadingFields' => [ 'title' => '级联字段列表定义（使用方式 参考 通知文体的定义）', 'type' => 'array', 'items' => ['title' => '级联字段', '$ref' => '#/components/schemas/WritingStyleTemplateField'], ], 'Style' => [ 'title' => '前端样式定义', 'type' => 'object', 'properties' => [ 'Placeholder' => ['title' => '输入框占位符', 'type' => 'string'], 'Type' => ['title' => '表单对应的前端组件样式，可选值：{\\"input\\", \\"textArea\\", \\"inputNumber\\", \\"datePicker\\", \\"segmented\\", \\"select\\", \\"inputWord\\", \\"inputTree\\"}', 'type' => 'string'], 'ShowTime' => ['title' => '日期选择器是否支持时间', 'type' => 'boolean'], 'Suffix' => ['title' => '输入框后缀（用来展示单位）', 'type' => 'string'], 'Description' => ['title' => '输入框提示文案', 'type' => 'string'], 'Format' => ['title' => '日期格式', 'type' => 'string'], ], ], 'Key' => ['title' => '表单KEY', 'type' => 'string'], ], ], ], ], 'apis' => [ 'AddAuditTerms' => [ 'summary' => 'Add a custom term to the audit dictionary.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Keyword', 'type' => 'string', 'example' => '龘', 'required' => false], ], [ 'name' => 'SuggestWord', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Suggested word', 'type' => 'string', 'example' => '龘(dá)', 'required' => false], ], [ 'name' => 'TermsDesc', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Audit basis', 'type' => 'string', 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字，文字释义为群龙腾飞的样子，昂扬而热烈。', 'required' => false], ], [ 'name' => 'ExceptionWord', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Exception phrase', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Exception phrase', 'type' => 'string', 'required' => false, 'example' => '例外语句'], 'required' => false, 'example' => '', ], ], [ 'name' => 'TermsName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the dictionary. Optional. If not specified, defaults to Default.', 'type' => 'string', 'required' => false, 'example' => 'Default'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Business data (whether the update succeeded). This field is deprecated. Use DataV1 to get the primary key ID instead.', 'type' => 'boolean', 'example' => 'true'], 'DataV1' => [ 'description' => 'ID of the added dictionary term', 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '562fe4163a59d7bcb44bfdde4e3d5046'], ], 'example' => '返回添加的实体信息', ], ], 'example' => '', ], ], ], '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\\": true,\\n \\"DataV1\\": {\\n \\"Id\\": 0\\n }\\n}","type":"json"}]', 'title' => 'Add a custom word library record', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-09-08T11:43:52.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-08-15T05:32:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AddAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'AddDatasetDocument' => [ 'summary' => 'Adds a document to a data source.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Model Studio workspace. For more information, see [Obtain a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the dataset.', 'type' => 'string', 'example' => '数据集名称', 'required' => false], ], [ 'name' => 'Document', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The document.', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'The unique system ID of the document. The system automatically generates this ID. You do not need to specify this parameter.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], 'Url' => ['description' => 'The URL of the article. The URL must be accessible over the public network.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx', 'title' => ''], 'Content' => [ 'description' => 'The content.', 'enumValueTitles' => [], 'type' => 'string', 'example' => '正文', 'required' => false, 'title' => '', ], 'Summary' => ['title' => '', 'description' => 'The summary of the article.', 'type' => 'string', 'example' => '文章摘要', 'required' => false], 'Title' => ['description' => 'The title of the document.', 'type' => 'string', 'required' => false, 'example' => '标题', 'title' => ''], 'PubTime' => ['description' => 'The publishing time.', 'type' => 'string', 'example' => '2024-12-09 13:35:40', 'required' => false, 'title' => ''], 'SourceFrom' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => 'xxx媒体', 'required' => false], 'MultimodalIndexName' => ['title' => '', 'description' => 'Deprecated. This parameter is not available.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], 'DisableHandleMultimodalMedia' => ['title' => '', 'description' => 'Specifies whether to disable the indexing of multimodal data, such as images and videos, in the current record. The default value is true.', 'type' => 'boolean', 'example' => 'false', 'required' => false], 'MultimodalMedias' => [ 'description' => 'A list of multimodal data in the document.'."\n" ."\n" .'- If a document, such as a rich text document, contains multimodal data like images or videos, you can pass the data using this parameter. This allows the data to be retrieved in search results.'."\n" ."\n" .'- If the document itself is multimodal data, leave this field empty and specify the data using the docType and url parameters.', 'type' => 'array', 'items' => [ 'description' => 'The multimodal data.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique identifier of the multimodal data. The system automatically generates this ID. You do not need to specify this parameter.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], 'MediaType' => ['title' => '', 'description' => 'The type of the multimodal data.'."\n" ."\n" .'- image: an image'."\n" ."\n" .'- video: a video', 'type' => 'string', 'example' => 'image', 'required' => false], 'FileUrl' => ['title' => '', 'description' => 'The URL of the file. The URL must be accessible over the public network.', 'type' => 'string', 'example' => 'http://xxx', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'DocId' => ['title' => '', 'description' => 'The unique business ID of the document.', 'type' => 'string', 'example' => 'xx', 'required' => false], 'DocType' => ['title' => '', 'description' => 'The type of the document.'."\n" ."\n" .'- plainText: plain text. The content parameter is required.'."\n" ."\n" .'- richText: rich text in HTML format. The content parameter is required.'."\n" ."\n" .'- text: a text file. The url parameter is required.'."\n" ."\n" .'- pdf: a PDF file. The url parameter is required.'."\n" ."\n" .'- word: a Word document. The url parameter is required.'."\n" ."\n" .'- image: an image. The url parameter is required. Most common image formats are supported, such as GIF, PNG, JPG, and JPEG.'."\n" ."\n" .'- video: a video. The url parameter is required. Most common video formats are supported, such as MP4, AVI, WMV, and MOV.', 'type' => 'string', 'example' => 'image', 'required' => false], 'Extend1' => ['title' => '', 'description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xxx', 'required' => false], 'Extend2' => ['title' => '', 'description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], 'Extend3' => ['title' => '', 'description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xxx', 'required' => false], 'Metadata' => [ 'description' => 'The metadata.', 'title' => '', 'type' => 'object', 'properties' => [ 'VideoShots' => [ 'description' => 'The video shot information.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The video shot information.', 'title' => '', 'type' => 'object', 'properties' => [ 'StartTime' => ['title' => '', 'description' => 'The start time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], 'EndTime' => ['title' => '', 'description' => 'The end time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000'], 'Text' => ['title' => '', 'description' => 'The text information from the video shot analysis.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'AsrSentences' => [ 'description' => 'The speech or caption information.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The speech or caption information.', 'title' => '', 'type' => 'object', 'properties' => [ 'StartTime' => ['title' => '', 'description' => 'The start time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000'], 'EndTime' => ['title' => '', 'description' => 'The end time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000'], 'Text' => ['title' => '', 'description' => 'The speech or caption information.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'Text' => ['title' => '', 'description' => 'The description of the metadata. This field is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], 'KeyValues' => [ 'description' => 'The metadata in a key-value structure.', 'type' => 'array', 'items' => [ 'description' => 'The metadata in a key-value structure.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'example' => '', ], 'CategoryUuid' => ['description' => 'The unique identifier of the category.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'The tag name.', 'type' => 'array', 'items' => ['description' => 'The tag name.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocUuid' => ['description' => 'The unique system ID of the document.', 'type' => 'string', 'example' => '8df2d69d63a247b6b52ff455b2d426b6', 'title' => ''], 'DocId' => ['title' => '', 'description' => 'The unique business ID of the document.', 'type' => 'string', 'example' => 'xxx'], 'Status' => ['title' => '', 'description' => 'The status.'."\n" ."\n" .'- 1: created'."\n" ."\n" .'- 2: text index built'."\n" ."\n" .'- 3: multimodal index built'."\n" ."\n" .'- 100: full build completed'."\n" ."\n" .'- 0: failed', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ErrorCode' => ['description' => 'The error code for the exception.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误信息', 'title' => ''], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Data Source - Add Document to Dataset', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AddDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'AsyncCreateClipsTask' => [ 'summary' => 'Generates a video clip.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'required' => true, 'example' => '17a299a9-f223-4707-b0dd-4c22519bddf5'], ], [ 'name' => 'VoiceStyle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The type of narration voice.', 'type' => 'string', 'example' => '甜美女声'."\n" .'中国台湾话女声'."\n" .'舌尖男声'."\n" .'新闻男声'."\n" .'激昂解说'."\n" .'标准女声'."\n" .'悬疑解说'."\n" .'广告男声'."\n" .'温柔女声'."\n" .'资讯女声'."\n" .'新闻女声'."\n" .'萝莉女声'."\n" .'磁性男声', 'required' => false], ], [ 'name' => 'MusicUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The URL of the background music.', 'type' => 'string', 'example' => 'http://music.mp4', 'required' => false], ], [ 'name' => 'ColorWords', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The array of animated text elements.', 'type' => 'array', 'items' => [ 'description' => 'The animated text structure.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content of the animated text.', 'type' => 'string', 'example' => '花字内容', 'required' => false], 'TimelineIn' => ['title' => '', 'description' => 'The start time of the animated text, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'required' => false], 'TimelineOut' => ['title' => '', 'description' => 'The end time of the animated text, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'required' => false], 'X' => ['title' => '', 'description' => 'The X coordinate of the animated text position.', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'required' => false], 'Y' => ['title' => '', 'description' => 'The Y coordinate of the animated text position.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'required' => false], 'FontSize' => ['title' => '', 'description' => 'The font size of the animated text.', 'type' => 'integer', 'format' => 'int32', 'example' => '默认120', 'required' => false], 'EffectColorStyle' => ['title' => '', 'description' => 'The style of the animated text.', 'type' => 'string', '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, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The [Bailian workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-ipe7d81yq4sl5jmk'], ], [ 'name' => 'VoiceVolume', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The volume of the narration voice.', 'type' => 'integer', 'format' => 'int32', 'example' => '0-10，默认5', 'required' => false], ], [ 'name' => 'MusicVolume', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The volume of the background music.', 'type' => 'integer', 'format' => 'int32', 'example' => '0-10，默认5', 'required' => false], ], [ 'name' => 'SubtitleFontSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The font size of the subtitles.', 'type' => 'integer', 'format' => 'int32', 'example' => '默认120', 'required' => false], ], [ 'name' => 'Height', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The height of the video.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'required' => false], ], [ 'name' => 'Width', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The width of the video.', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'required' => false], ], [ 'name' => 'CloseVoice', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to disable the narration voice.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'CloseMusic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to disable the background music.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'CloseSubtitle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to disable the subtitles.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], [ 'name' => 'CustomVoiceUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The URL of the custom audio track.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'required' => false], ], [ 'name' => 'CustomVoiceVolume', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The volume of the custom audio track.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'required' => false], ], [ 'name' => 'Stickers', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The array of sticker structures.', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The sticker array element.', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The public URL of the GIF file.', 'type' => 'string', 'example' => 'http://xxx/xxx.gif', 'required' => false], 'TimelineIn' => ['title' => '', 'description' => 'The start time of the sticker, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'required' => false], 'Duration' => ['title' => '', 'description' => 'The display duration of the sticker, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], 'X' => ['title' => '', 'description' => 'The X coordinate of the sticker position.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'required' => false], 'Y' => ['title' => '', 'description' => 'The Y coordinate of the sticker position.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'required' => false], 'Width' => ['title' => '', 'description' => 'The width of the sticker.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'required' => false], 'Height' => ['title' => '', 'description' => 'The height of the sticker.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'required' => false], 'DyncFrames' => ['title' => '', 'description' => 'The number of dynamic frames in the GIF file.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'required' => false], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'CustomVoiceStyle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The voice tone of CosyVoice.', 'type' => 'string', 'example' => 'longxian_normal', 'required' => false], ], [ 'name' => 'CosyVoiceAppKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The AppKey of CosyVoice.', 'type' => 'string', 'example' => 'ddgsase', 'required' => false], ], [ 'name' => 'CosyVoiceToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The token of CosyVoice.', 'type' => 'string', 'example' => 'xxsfazs', 'required' => false], ], [ 'name' => 'MusicStyle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The type of recommended music.', 'type' => 'string', 'example' => '浪漫, 美食,国风,轻快,动感,舒缓,搞怪,时尚', 'required' => false], ], [ 'name' => 'OpeningCreditsUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The URL of the opening credits video.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'required' => false], ], [ 'name' => 'ClosingCreditsUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The URL of the closing credits video.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'required' => false], ], [ 'name' => 'HighDefSourceVideos', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The list of high-definition video structures.', 'type' => 'array', 'items' => [ 'description' => 'The high-definition video structure.', 'type' => 'object', 'properties' => [ 'VideoId' => ['title' => '', 'description' => 'The ID of the video.', 'type' => 'string', 'example' => '00d59b6de13971f0bcd84531949c0102', 'required' => false], 'VideoName' => ['title' => '', 'description' => 'The name of the video.', 'type' => 'string', 'example' => 'video001.mp4', 'required' => false], 'VideoUrl' => ['title' => '', 'description' => 'The URL of the video.', 'type' => 'string', 'example' => 'http://fotor-cn-cutout.oss-cn-shanghai.aliyuncs.com/cutout_tmp/01ba219486f043b4b339e7080e5cf11d.mp4', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Alignment', 'in' => 'formData', 'schema' => ['title' => '', '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传入字幕右上角顶点相对于视频左上角的坐标', 'description' => ''], ], [ 'name' => 'AdaptMode', 'in' => 'formData', 'schema' => ['title' => '', 'type' => 'string', 'example' => 'AutoWrap：自动换行'."\n" ."\n" .'AutoScale：自动缩放'."\n" ."\n" .'AutoWrapAtSpaces：只在空格位置自动换行（适用于纯英文字幕自动换行场景）', 'description' => ''], ], [ 'name' => 'TextWidth', 'in' => 'formData', 'schema' => ['title' => '', 'type' => 'string', 'example' => '将按照该值设置文本框宽度进行自动换行或缩放。不填写时，会按照视频宽度进行自动换行或缩放。当值大于0小于等于1时，表示相对输出视频的宽度，当值大于1时，表示绝对像素值。', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'The business data.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" .'- true: Succeeded.'."\n" .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create a video clipping task', 'changeSet' => [ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncCreateClipsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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' => 'Creates a timeline for smart video editing.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Unique task ID', 'type' => 'string', 'required' => true, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'title' => ''], ], [ 'name' => 'ProcessPrompt', 'in' => 'formData', 'schema' => ['description' => 'Prompt for processing', 'type' => 'string', 'example' => '口播内容是乌镇旅游宣传广告，口播内容时长约为1分钟，开头要描述乌镇是千年文化传承的江南水乡，之后要体现乌镇的传统手工艺、美食和美景，最后要号召大家来乌镇旅游', 'required' => false, 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Model Studio workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'CustomContent', 'in' => 'formData', 'schema' => ['description' => 'Custom voiceover content', 'type' => 'string', 'example' => '自定义口播内容', 'required' => false, 'title' => ''], ], [ 'name' => 'NoRefVideo', 'in' => 'formData', 'schema' => ['description' => 'Enable mimicry capability', 'type' => 'boolean', 'example' => '默认开启', 'required' => false, 'title' => ''], ], [ 'name' => 'AdditionalContent', 'in' => 'formData', 'schema' => ['description' => 'Supplementary material information to help generate the voiceover script', 'type' => 'string', 'example' => '素材附加信息', 'required' => false, 'title' => ''], ], [ 'name' => 'RecommendAudio', 'in' => 'formData', 'schema' => ['type' => 'boolean', 'example' => 'false', 'title' => '', 'description' => ''], ], [ 'name' => 'TimelineScene', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => 'null - 通用口播'."\n" .' 0-通用口播'."\n" .' 1- 高光', 'title' => '', 'description' => ''], ], [ 'name' => 'HighLightConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'HtPrompt' => ['type' => 'string', 'example' => '请从输入的音乐演出视频中，自动识别并提取出「最具视觉冲击力、情感爆发力或独特吸引力」...', 'title' => '', 'description' => ''], 'HtHighQualityLabel' => [ 'type' => 'array', 'items' => ['type' => 'string', 'example' => '"高清演员近景特写镜头【高优】"', 'title' => '', 'description' => ''], 'example' => '['."\n" .' "高清演员近景特写镜头【高优】",'."\n" .' "演出高潮-沉浸表演【高优】",'."\n" .' "演出高潮-近景表情【高优】"'."\n" .']', 'title' => '', 'description' => '', ], 'HtLowQualityLabel' => [ 'type' => 'array', 'items' => ['type' => 'string', 'example' => ' "画面昏暗"', 'title' => '', 'description' => ''], 'example' => '['."\n" .' "画面昏暗",'."\n" .' "采访画面",'."\n" .' "字幕画面"'."\n" .']', 'title' => '', 'description' => '', ], 'HtMinTimeLength' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'description' => ''], 'HtMaxTimeLength' => ['type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => '', 'description' => ''], 'HtSingleShotLen' => ['type' => 'integer', 'format' => 'int32', 'example' => '1.5', 'title' => '', 'description' => ''], 'HtAnalyzeRhythm' => ['type' => 'boolean', 'example' => 'false', 'title' => '', 'description' => ''], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Operation result: true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Creation of video editing voice-over timeline ', 'changeSet' => [ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncCreateClipsTimeLine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'AsyncEditTimeline' => [ 'summary' => 'Edits the timeline of a video editing task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the task', 'type' => 'string', 'required' => true, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba', 'title' => ''], ], [ 'name' => 'Timelines', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Array structure of video editing timelines', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Clips' => [ 'description' => 'Array of video clips', 'type' => 'array', 'items' => [ 'description' => 'Video clip', 'type' => 'object', 'properties' => [ 'OutEx' => ['description' => 'Clip end time, in milliseconds', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '3.66', 'title' => ''], 'ClipId' => ['description' => 'Clip ID', 'type' => 'string', 'required' => false, 'example' => '123jjdax'."\n" .'新增可为空', 'title' => ''], 'VideoId' => ['description' => 'Video ID', 'type' => 'string', 'required' => false, 'example' => '7036227ae3ab71efbb4a6733a68f0102'."\n" .'不可为空', 'title' => ''], 'VideoName' => ['description' => 'Video name', 'type' => 'string', 'required' => false, 'example' => '123.mp4'."\n" .'不可为空', 'title' => ''], 'In' => ['description' => 'Start time, in seconds. Deprecated.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'."\n" .'不可为空', 'title' => ''], 'ContentInner' => ['description' => 'Segmented voice-over script', 'type' => 'string', 'required' => false, 'example' => '口播文案分段'."\n" .'不可为空', 'title' => ''], 'InEx' => ['description' => 'Clip start time, in milliseconds', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.45', 'title' => ''], 'Out' => ['description' => 'End time, in seconds. Deprecated.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5'."\n" .'不可为空', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], 'TimelineId' => ['description' => 'Timeline ID', 'type' => 'string', 'required' => false, 'example' => 'sdfjhks'."\n" .'新增可为空', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Model Studio workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-az2gglkjauwnnhpq', 'title' => ''], ], [ 'name' => 'AutoClips', 'in' => 'formData', 'schema' => ['description' => 'Enable automatic clip adjustment', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Unique task ID', 'type' => 'string', 'example' => '51e4efd1908242eb93ca9bbb7fc4359d', 'title' => ''], 'Message' => ['description' => 'Response message', 'type' => 'string', 'example' => '一些建议信息', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error description', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Edit the voice-over timeline for video editing ', 'changeSet' => [ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-18T12:12:07.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:AsyncEditTimeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'AsyncUploadTenderDoc' => [ 'summary' => 'Upload a tender document.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq', 'title' => ''], ], [ 'name' => 'TenderDocName', 'in' => 'formData', 'schema' => ['description' => 'Tender document name', 'type' => 'string', 'required' => false, 'example' => 'tender.pdf', 'title' => ''], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['description' => 'File OSS key', 'type' => 'string', 'required' => false, 'example' => 'oss://default/aimiaobi-service-prod/aimiaobi/materialDocument/1601892701595700_10169811/208757545922605632_yst-test_9eb7d7e1deb543d88e2d6f1c9df456ef.docx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error description', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Tender document parsing', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncUploadTenderDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'AsyncUploadVideo' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'SourceVideos', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The structure of the video editing materials.', 'type' => 'array', 'items' => [ 'description' => 'The structure of the video editing materials.', 'type' => 'object', 'properties' => [ 'VideoName' => ['description' => 'The name of the video.', 'type' => 'string', 'required' => true, 'example' => '123.mp4', 'title' => ''], 'VideoUrl' => [ 'description' => 'The URL of the video.', 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'example' => 'http://123.mp4'."\n" .'目前该接口只进行视频理解额和分析，并没有对文件进行转存。请保证视频地址在任务执行期间有效。', 'title' => '', ], 'VideoExtraInfo' => ['description' => 'Additional description of the video.', 'type' => 'string', 'example' => '视频中有一个房子', 'required' => false, 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'AnlysisPrompt', 'in' => 'formData', 'schema' => ['description' => 'The prompt for video understanding.', 'type' => 'string', 'example' => '重点理解视频中的风景信息', 'required' => false, 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[The ID of the Alibaba Cloud Model Studio workspace.](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxx', 'title' => ''], ], [ 'name' => 'ReferenceVideo', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Information about the reference video.', 'type' => 'object', 'properties' => [ 'VideoName' => ['description' => 'The name of the reference video.', 'type' => 'string', 'example' => 'refvideo.mp4', 'required' => false, 'title' => ''], 'VideoUrl' => ['description' => 'The URL of the video.', 'type' => 'string', 'example' => 'http://viapi-customer-pop.oss-cn-shanghai.aliyuncs.com/d71e_208334498220521996_51298e0a909d457693166eb883768c7a', 'required' => false, 'title' => ''], 'VideoExtraInfo' => ['description' => 'Additional information for video understanding.', 'type' => 'string', 'example' => '手机cpu采用3纳米技术', 'required' => false, 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'SplitInterval', 'in' => 'formData', 'schema' => ['description' => 'The time interval for video understanding shots.', 'type' => 'integer', 'format' => 'int32', 'example' => '默认1', 'required' => false, 'title' => ''], ], [ 'name' => 'VideoRoles', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Face information of the roles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The name of the role.', 'title' => '', 'type' => 'object', 'properties' => [ 'RoleName' => ['title' => '', 'description' => 'The name of the role.', 'type' => 'string', 'example' => '李晓明', 'required' => false], 'RoleInfo' => ['title' => '', 'description' => 'Information about the role.', 'type' => 'string', 'example' => '李晓明是一位警察', 'required' => false], 'RoleUrls' => [ 'description' => 'The URLs of the role photos.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Information about the role\'s image file.', 'title' => '', 'type' => 'object', 'properties' => [ 'RoleFileName' => ['title' => '', 'description' => 'The file name of the role\'s facial image.', 'type' => 'string', 'example' => '王小明.jpeg', 'required' => false], 'RoleFileUrl' => ['title' => '', 'description' => 'The public URL of the role\'s facial image.', 'type' => 'string', 'example' => 'http://xxx/xxx.jpeg', 'required' => false], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'FaceIdentitySimilarityMinScore', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The similarity threshold for character recognition.', 'type' => 'number', 'format' => 'double', 'example' => '0.7', 'required' => false], ], [ 'name' => 'VideoShotFaceIdentityCount', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of frames sampled from a single shot for character matching.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'required' => false], ], [ 'name' => 'RemoveSubtitle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Removes captions from the material.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], [ 'name' => 'TaskName', 'in' => 'formData', 'schema' => ['description' => 'Job name ', 'type' => 'string', 'example' => 'task001', 'required' => false, 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'formData', 'schema' => ['description' => 'Task Type ', 'type' => 'string', 'example' => 'type001', 'required' => false, 'title' => ''], ], [ 'name' => 'AdaptiveThreshold', 'in' => 'formData', 'schema' => ['description' => 'Shot segmentation threshold. A smaller value increases sensitivity. Valid range is 1 to 10. Default value is 3.', 'type' => 'number', 'format' => 'float', 'example' => '3.0', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'], 'Code' => ['description' => 'The status code returned for the request.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'The business data.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'VideoInfos' => [ 'description' => 'Information about the videos.', 'type' => 'array', 'items' => [ 'description' => 'Information about the video.', 'type' => 'object', 'properties' => [ 'VideoId' => ['description' => 'The video ID.', 'type' => 'string', 'example' => '60616fad41b171f0bb4b4531948c0102', 'title' => ''], 'VideoName' => ['description' => 'The name of the video.', 'type' => 'string', 'example' => '123.mp4', 'title' => ''], 'VideoUrl' => ['description' => 'The video URL.', 'type' => 'string', 'example' => 'http://123.mp4', 'title' => ''], 'VideoExtraInfo' => ['description' => 'Additional information about the video.', 'type' => 'string', 'example' => '视频中有一个房子', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Asynchronously upload video clip materials', 'summary' => 'Uploads video assets for editing.', 'changeSet' => [ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncUploadVideo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'AsyncWritingBiddingDoc' => [ 'summary' => 'An API for writing bidding documents.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[The ID of the workspace.](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the task.', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'The prompt.', 'type' => 'string', 'required' => false, 'example' => '自定义观点的输入Prompt', 'title' => ''], ], [ 'name' => 'CompanyKeyword', 'in' => 'formData', 'schema' => ['description' => 'The name of the bidding company.', 'type' => 'string', 'required' => false, 'example' => 'comany name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The business data.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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 },\\n \\"Code\\": \\"successful\\"\\n}","type":"json"}]', 'title' => 'Bid Document Writing', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncWritingBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'BindPptArtifact' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[The workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xgpt3m25qdosdjr3'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '85da2bfe-6f05-41af-9841-d73c5bbf43a2'], ], [ 'name' => 'ArtifactId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The artifact ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '12342'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The response object of the task.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '110f8401-e5ba-42db-addb-4f70196000c1'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Attach PPT work information ', 'summary' => 'Binds a PowerPoint (PPT) artifact.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:BindPptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'CancelAsyncTask' => [ 'summary' => 'Cancels pending asynchronous tasks.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> The system automatically generates the TaskId. This parameter does not need to be specified. If subsequent tasks use the same TaskId, they are grouped into the same conversation.', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Indicates whether the task was canceled successfully.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => ['title' => '', 'description' => 'Business-related data', 'type' => 'boolean', 'example' => 'true'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'A description of the error.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'FB698445-61DA-5361-BF73-1C5F1157E888'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates that the request was successful. A value of false indicates that the request failed.', 'type' => 'boolean', 'example' => 'True'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Cancel asynchronous task', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CancelAsyncTask'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:CancelAsyncTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'CancelAuditTask' => [ 'summary' => 'Cancel an audit task.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ContentAuditTaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Audit task ID. Specify either this parameter or ArticleId.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'ArticleId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Article ID. Specify either this parameter or ContentAuditTaskId.', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => ['title' => '', 'description' => 'Indicates whether the audit task was canceled successfully', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Cancel a review job ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:CancelAuditTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CancelDeepWriteTask' => [ 'summary' => 'Cancels a deep writing task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'required' => false, 'example' => 'xbabac91-fdad-44d6-95ce-******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'Task response object', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => 'xbabac91-fdad-44d6-95ce-******'], 'Input' => ['title' => '', 'description' => 'User query', 'type' => 'string', 'example' => '北京2025年新能源汽车发展趋势'], 'Status' => [ 'title' => '', 'description' => 'Task status', 'enumValueTitles' => ['in_progress' => 'Running', 'queued' => 'Queued', 'cancelled' => 'Cancelled', 'completed' => 'Completed', 'failed' => 'Failed'], 'type' => 'string', 'example' => 'cancelled', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Cancel a depth writing job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:CancelDeepWriteTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ClearIntervenes' => [ 'summary' => 'Clears all intervention content.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'FailIdList' => [ 'description' => 'List of failed index IDs', 'title' => '', 'type' => 'array', 'items' => ['description' => 'ID of the failed intervention item', 'type' => 'string', 'example' => '"1234"', 'title' => ''], 'example' => '', ], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Code' => ['description' => 'Status code returned by the intervention service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Purge all intervention items', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:ClearIntervenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ConfirmAndPostProcessAuditNote' => [ 'summary' => 'This interface confirms whether the parsing results from your custom rule library submission are used for audit tasks. Because parsing results may not meet your requirements, use this interface to perform a second confirmation. If you are satisfied with the parsing of your submitted rule library, provide the TaskId from that submission as an input parameter. The system then post-processes your uploaded rule library and makes it available for auditing. Otherwise, invoke the SubmitAuditNote interface again to upload the modified rule library.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Alibaba Cloud Model Studio workspace unique identifier: Get [Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The TaskId obtained from the SubmitAuditNote interface. This is the unique identifier for the custom rule library task index. Store it securely when using it.', 'type' => 'string', 'required' => true, 'example' => 'xxx_Default_1241541251241'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates if the request was successful', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'The task ID obtained after confirming the use of this parsing result. It is consistent with the input parameter, returned here for your convenience.', 'type' => 'string', 'example' => '33'], ], 'example' => '', ], ], ], '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\\": \\"33\\"\\n}","type":"json"}]', 'title' => 'Confirm Submission of Rule Library for Review', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:ConfirmAndPostProcessAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateDataPermissions' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get workspaceId](~~2587495~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'], ], [ 'name' => 'DataType', 'in' => 'formData', 'schema' => ['description' => 'The permission type. Currently, only \\`dataset\\` is supported.', 'type' => 'string', 'required' => true, 'example' => 'dataset', 'title' => ''], ], [ 'name' => 'DataId', 'in' => 'formData', 'schema' => ['description' => 'A unique identifier for the permission.', 'type' => 'string', 'required' => true, 'example' => 'SystemSearch.QuarkCommonNews', 'title' => ''], ], [ 'name' => 'PermissionUserInfos', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'PermissionUserId' => ['description' => 'The user ID.'."\n" ."\n" .'- For a RAM user: The ID of the RAM user.'."\n" ."\n" .'- For a role user: The user identity in the format AssumedRoleUser${roleId}.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1'], 'PermissionUsername' => ['description' => 'The username.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'], ], 'title' => '', 'description' => 'A user.', 'required' => false, 'example' => '', ], 'required' => true, 'title' => '', 'description' => 'The users to whom you want to assign permissions.', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'title' => '', 'description' => 'The response.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateDataPermissions', 'summary' => 'Batch add permissions:\\'."\n" .'\\- Dataset permissions\\', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateDataPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'CreateDataset' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'], ], [ 'name' => 'DatasetType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The type of the dataset. Valid values:'."\n" ."\n" .'- CustomSemanticSearch: A custom semantic index. This is the default value. Upload documents to build the dataset.'."\n" ."\n" .'- ThirdSearch: A third-party search source (API). Configure your own search API.', 'type' => 'string', 'example' => 'CustomSemanticSearch', 'default' => 'CustomSemanticSearch', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the dataset. The name must be globally unique.', 'type' => 'string', 'required' => true, 'example' => 'businessDataset'], ], [ 'name' => 'DatasetDescription', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The description of the dataset. This is the display name in the console. Use a human-readable name.', 'type' => 'string', 'example' => '企业知识库', 'required' => false], ], [ 'name' => 'SearchDatasetEnable', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The dataset search switch. Valid values:'."\n" ."\n" .'- 0: Disabled for all.'."\n" ."\n" .'- 1: Visible only to Miao Search.'."\n" ."\n" .'- 2: Visible only to Miao Bi.'."\n" ."\n" .'- 3: Visible to both Miao Search and Miao Bi. This is the default value.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'default' => '3', 'required' => false], ], [ 'name' => 'DatasetConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The dataset search configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceConfigs' => [ 'description' => 'Third-party search: API definition.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Third-party search: API definition.', 'type' => 'object', 'properties' => [ 'DemoQuery' => ['title' => '', 'description' => 'A searchable keyword used to verify availability.', 'type' => 'string', 'example' => '可以搜索到的关键词，用来验证是否可用', 'required' => false], 'Size' => ['title' => '', 'description' => 'The default limit on the number of data entries for requests and responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], 'SearchSourceRequestConfig' => [ 'description' => 'API request configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The API URL.', 'type' => 'string', 'example' => 'api地址', 'required' => false], 'Method' => ['title' => '', 'description' => 'The request method.', 'type' => 'string', 'example' => '请求方式', 'required' => false], 'ConnectTimeout' => ['title' => '', 'description' => 'The connection timeout period, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'required' => false], 'SocketTimeout' => ['title' => '', 'description' => 'The read timeout period, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'required' => false], 'Headers' => [ 'description' => 'The HTTP request headers.', 'type' => 'array', 'items' => [ 'description' => 'The HTTP request headers.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => '参数名称', 'required' => false], 'ValueType' => ['title' => '', 'description' => 'The data type of the parameter value. The default value is string.', 'type' => 'string', 'example' => '参数值数据类型：默认string', 'required' => false], 'ValueFormat' => ['title' => '', 'description' => 'This parameter is valid only when ValueType is set to time.', 'type' => 'string', 'example' => 'valueType = time 时有效', 'required' => false], 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => '参数值', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'The request path parameters.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => '参数名称', 'required' => false], 'ValueType' => ['title' => '', 'description' => 'The data type of the parameter value. The default value is string.', 'type' => 'string', 'example' => '参数值数据类型：默认string', 'required' => false], 'ValueFormat' => ['title' => '', 'description' => 'This parameter is valid only when ValueType is set to time.', 'type' => 'string', 'example' => 'valueType = time 时有效', 'required' => false], 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => '参数值', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'PathParamsEnable' => ['title' => '', 'description' => 'Specifies whether to enable path parameters.', 'type' => 'boolean', 'example' => 'true', 'required' => false], 'Body' => ['title' => '', 'description' => 'The request body.', 'type' => 'string', 'example' => '{}', 'required' => false], ], 'required' => false, 'example' => '', ], 'SearchSourceResponseConfig' => [ 'description' => 'API response configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'JqNodes' => [ 'description' => 'Node configuration.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The node key.', 'type' => 'string', 'example' => '节点key', 'required' => false], 'Type' => ['title' => '', 'description' => 'The data type of the node. Valid values: string, number, list, object, and base.', 'type' => 'string', 'example' => '节点数据类型：string number list object base', 'required' => false], 'Path' => ['title' => '', 'description' => 'The node path.', 'type' => 'string', 'example' => '节点路径', 'required' => false], 'JqNodes' => [ 'description' => 'Child node configuration.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Child node configuration.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The node key.', 'type' => 'string', 'required' => false, 'example' => 'title'], 'Type' => ['title' => '', 'description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'string'], 'Path' => ['title' => '', 'description' => 'The path.', 'type' => 'string', 'required' => false, 'example' => '节点路径'], 'JqNodes' => [ 'description' => 'Child node configuration.', 'type' => 'array', 'items' => [ 'description' => 'Child node configuration.', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The node key.', 'type' => 'string', 'required' => false, 'example' => 'title'], 'Type' => ['title' => '', 'description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'string'], 'Path' => ['title' => '', 'description' => 'The node path.', 'type' => 'string', 'required' => false, 'example' => '节点路径'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'SearchSourceConfig' => [ 'description' => 'Dataset configuration items.', 'type' => 'object', 'properties' => [ 'TagSearchEnable' => ['description' => 'Specifies whether tags are used in searches. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'TagGenerateEnable' => ['description' => 'Specifies whether tags are used in generation. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'MetadataKeyValueSearchEnable' => ['description' => 'Specifies whether the metadata key-value pairs are used in searches. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'MetadataKeyValueGenerateEnable' => ['description' => 'Specifies whether the metadata key-value pairs are used in generation. The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'DocumentHandleConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Dataset index configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'DisableHandleMultimodalMedia' => ['title' => '', 'description' => 'Disables the processing logic for multimedia files.'."\n" ."\n" .'- true: Disables multimodal (image and video) indexing. Only text is indexed and searched.'."\n" ."\n" .'- false: Enables multimodal (text, image, and video) indexing. This setting takes effect only after you activate ApsaraVideo and grant authorization in system administration. If you set this to false but authorization is not granted, image and video indexing is automatically skipped. This is the default value.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'InvokeType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The invocation method. Currently, only portal is supported, which indicates an invocation from the console.'."\n" ."\n" .'- If left empty: When DatasetType is ThirdSearch, datasetConfig.SearchSourceConfigs (third-party API definition) is required.'."\n" ."\n" .'- If set to portal: When DatasetType is ThirdSearch, the system initializes a SearchSourceConfigs (third-party API demo) example by default for your reference.', 'type' => 'string', 'example' => 'portal', 'required' => false], ], [ 'name' => 'AccessLevel', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'private', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'DatasetId' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'CreateUser' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => 'xxx'], 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-12 21:46:24'], 'DatasetType' => ['title' => '', 'description' => 'The dataset type.', 'type' => 'string', 'example' => 'CustomSemanticSearch'], 'DatasetName' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'xxx'], 'DatasetDescription' => ['title' => '', 'description' => 'The display name of the dataset.', 'type' => 'string', 'example' => 'xxx'], 'SearchDatasetEnable' => ['title' => '', 'description' => 'The dataset search switch.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Data source - Creation ', 'summary' => 'Creates a dataset.', 'changeSet' => [ ['createdAt' => '2025-05-06T08:40:24.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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 \\"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"}]', 'translator' => 'machine', ], 'CreateGeneralConfig' => [ 'summary' => 'General configurations — Create', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Model Studio workspace. [Get the workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-'], ], [ 'name' => 'ConfigKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the configuration item. Supported keys include the following:'."\n" ."\n" .'- MiaoSou text search threshold (double): searchGenerate.searchTextMinScore'."\n" ."\n" .'- MiaoSou image search threshold (double): searchGenerate.searchImageMinScore'."\n" ."\n" .'- MiaoSou video search threshold (double): searchGenerate.searchVideoMinScore'."\n" ."\n" .'- MiaoSou audio search threshold (double): searchGenerate.searchAudioMinScore'."\n" ."\n" .'- MiaoSou Q\\&A search general answer summary prompt template (string): searchGenerate.sumQaAgentPrompt'."\n" ."\n" .'- MiaoSou Q\\&A search general answer summary prompt template with text and images (string): searchGenerate.sumQaAgentVlPrompt'."\n" ."\n" .'- MiaoSou Q\\&A search deep answer summary prompt template (string): searchGenerate.sumQaEnhanceAgentPrompt'."\n" ."\n" .'- MiaoSou Q\\&A search deep answer summary prompt template with text and images (string): searchGenerate.sumQaEnhanceAgentVlPrompt', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'ConfigValue', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Value of the configuration item', 'type' => 'string', 'required' => true, 'example' => 'xxx'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response object', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'false'], 'Data' => [ 'description' => 'Response data', 'title' => '', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'Unique identifier of the configuration item', 'type' => 'string', 'example' => 'xx'], 'ConfigValue' => ['title' => '', 'description' => 'Configuration value', 'type' => 'string', 'example' => 'xx'], 'ConfigValueType' => ['title' => '', 'description' => 'Configuration type', 'type' => 'string', 'example' => 'xx'], 'ConfigDesc' => ['title' => '', 'description' => 'Configuration description', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'General Configuration - Creation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'CreateGeneratedContent' => [ 'summary' => 'Saves an article created in Miaobi. This operation supports rich text.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxx_efm'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The last generated prompt.', 'type' => 'string', 'required' => false, 'example' => '创作xxx文章'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the task.'."\n" ."\n" .'> The system automatically generates a task ID. You do not need to specify this parameter. If you specify the same task ID for multiple tasks, they are grouped into a single conversation.', 'type' => 'string', 'required' => true, 'maxLength' => 64, 'minLength' => 6, 'example' => 'xxx'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'required' => true, 'maxLength' => 200, 'minLength' => 2, 'example' => '杭州亚运会'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The body of the content, in rich text format.', 'type' => 'string', 'required' => true, 'example' => '杭州亚运会'], ], [ 'name' => 'ContentDomain', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The domain for content generation.', 'type' => 'string', 'example' => 'government', 'default' => 'media', 'enum' => ['media', 'government', 'hottopic', 'custom', 'office', 'market'], 'required' => false, ], ], [ 'name' => 'ContentText', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The body of the content, in plain text format.', 'type' => 'string', 'required' => false, 'example' => '杭州亚运会'], ], [ 'name' => 'Uuid', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The traceability UUID.', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'Keywords', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The keywords.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A keyword.', 'type' => 'string', 'required' => false, 'example' => '关键词', 'title' => ''], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'success'], 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'integer', 'format' => 'int64', 'example' => '42'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'false'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Save Document', 'changeSet' => [ ['createdAt' => '2025-05-13T08:39:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-09T07:40:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'CreateToken' => [ 'summary' => 'Creates a temporary token for the online inference API.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'ExpiredTime' => ['title' => '', 'description' => 'The expiration time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1705388704855'], 'Token' => ['title' => '', 'description' => 'The access token.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain an authorization token', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'CreateToken'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'DeleteAuditNote' => [ 'summary' => 'Deletes all custom rule libraries available for audit under the user account. This operation is irreversible. To archive rule libraries, use the DownloadAuditNote API to save them before deletion.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier for an Alibaba Cloud Model Studio workspace: Get the [Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'NoteId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Rule library ID. If left blank, the default is used.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether this request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Deletion result. If deletion is successful, "SUCCESSED" is returned.', 'type' => 'string', 'example' => 'SUCCESSED'], ], 'example' => '', ], ], ], '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\\": \\"SUCCESSED\\"\\n}","type":"json"}]', 'title' => 'Delete Rule Library', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteAuditTerms' => [ 'summary' => 'Deletes specified term records.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for the Alibaba Cloud Model Studio workspace. Get the [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'IdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of rule IDs for user logon audit terms to delete.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Rule ID for a user logon audit term to delete.', 'type' => 'integer', 'format' => 'int64', 'example' => '4463', 'required' => false], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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\\": true\\n}","type":"json"}]', 'title' => 'Delete the specified dictionary record', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteCustomText' => [ 'summary' => 'Deletes a custom text.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '85'], ], [ 'name' => 'CommodityCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'required' => false, 'example' => '商品code'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => ['title' => '', 'description' => 'Indicates whether the text was deleted successfully.', 'type' => 'boolean', 'example' => 'true'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Delete custom text', 'changeSet' => [ ['createdAt' => '2024-08-13T00:21:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-08-13T00:21:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteCustomTopicByTopic' => [ 'summary' => 'Delete a custom hot spot event by topic name.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Workspace unique identifier: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom topic', 'type' => 'string', 'required' => true, 'example' => '话题'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'integer', 'format' => 'int32', 'example' => '33'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Request unique identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Delete custom hot spot management event', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteCustomTopicByTopic', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteCustomTopicViewPointById' => [ 'summary' => 'Deletes a custom topic viewpoint by its ID.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'CustomViewPointId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom viewpoint ID', 'type' => 'string', 'required' => true, 'example' => 'dfd73894e6a94fd79fe7ffbe865796fb'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'integer', 'format' => 'int32', 'example' => '7'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Operation result: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Delete Custom Topic Perspective', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteCustomTopicViewPointById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteDataPermissions' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspace ID](~~2587495~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxx'], ], [ 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'type' => 'array', 'items' => ['description' => 'A permission ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1'], 'required' => true, 'title' => '', 'description' => 'The permission IDs.', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates that the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'title' => '', 'description' => 'The response.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DeleteDataPermissions', 'summary' => 'Batch delete dataset permissions', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDataPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'DeleteDataset' => [ 'summary' => 'Deletes a dataset from the data source.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of Alibaba Cloud Model Studio workspace: [Get workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the dataset', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], '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' => 'Data Source - Delete', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteDatasetDocument' => [ 'summary' => 'Delete source documents.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the dataset. Choose either DatasetId or DatasetName.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Dataset name', 'type' => 'string', 'example' => '数据集名称', 'required' => false], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The user-specified unique ID of the document.', 'type' => 'string', 'example' => 'xxx', 'required' => false], ], [ 'name' => 'DocUuid', 'in' => 'formData', 'schema' => ['description' => 'The internal unique identifier of the document.', 'type' => 'string', 'example' => 'xxx', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response result', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The unique identifier of the deleted document.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for successful, false for failed.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Data Source - Delete Dataset Document', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteDocs' => [ 'summary' => 'Deletes multiple documents.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier for the Alibaba Cloud Model Studio workspace. Get the [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'DocIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Document ID array.', 'type' => 'array', 'items' => ['description' => 'Document ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Internal error code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '2C565EDD-E624-5FED-8565-0A9CB0C8CC46'], 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Batch delete documents', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDocs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'DeleteFactAuditUrl' => [ 'summary' => 'Deletes the specified URL used for factuality audit.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. Get the [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'Url', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The URL of the audit information source you want to delete. The provided URL must match the result from GetFactAuditUrl for successful deletion.', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Success message for deleting the URL.', 'type' => 'string', 'example' => 'SUCCESSED'], ], 'example' => '', ], ], ], '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\\": \\"SUCCESSED\\"\\n}","type":"json"}]', 'title' => 'Delete Factuality Review URL', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteFactAuditUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteGeneralConfig' => [ 'summary' => 'Deletes general configurations.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Model Studio workspace. For more information, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-'], ], [ 'name' => 'ConfigKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the configuration.', 'type' => 'string', 'required' => true, 'example' => 'xx'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], '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' => 'General Configuration - Delete', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DeleteGeneratedContent' => [ 'summary' => 'Deletes an article created in MiaoBi.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the document', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '99'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'boolean', 'example' => 'true'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Unique identifier of the request', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": true\\n}","type":"json"}]', 'title' => 'Delete Document', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'DeleteInterveneRule' => [ 'summary' => 'Deletes an intervention rule.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'RuleId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'FailIdList' => [ 'description' => 'List of failed index IDs', 'title' => '', 'type' => 'array', 'items' => ['description' => 'List of failed IDs', 'type' => 'string', 'example' => '12345', 'title' => ''], 'example' => '', ], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => 'dt-s50ntwtywb4y'], 'Code' => ['description' => 'Status code returned by the intervention service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'], 'Success' => ['title' => '', 'description' => 'Whether the operation was successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Delete intervention rules', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteInterveneRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'DeleteMaterialById' => [ 'summary' => 'Deletes a material from the material library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Indicates whether the material was successfully deleted.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Data' => ['title' => '', 'description' => 'The data returned.', 'type' => 'boolean', 'example' => 'false'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'false'], ], 'example' => '', ], ], ], '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' => 'Delete Material', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteMaterialById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'DeleteMaterialById'], ], ], ], 'DeletePptArtifact' => [ 'summary' => 'Delete a PPT work', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'], ], [ 'name' => 'PptArtifactId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the PPT work.', 'type' => 'string', 'required' => false, 'example' => '53245'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'PptArtifactId' => ['title' => '', 'description' => 'The ID of the PPT work.', 'type' => 'integer', 'format' => 'int32', 'example' => '5233498'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Delete a PPT work ', 'description' => '- This API operation uses the HTTP Server-Sent Events (SSE) protocol.'."\n" ."\n" .'- The OpenAPI portal is not compatible with the SSE inference protocol. You cannot directly test this API operation in the portal. For more information about how to call this API operation using the software development kit (SDK) for Java or Python, see [PPT Generation Best practices](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices).'."\n" ."\n" .'- To obtain the latest version of the asynchronous Java SDK, see [this link](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' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'translator' => 'machine', ], 'DeleteStyleLearningResult' => [ 'summary' => 'Deletes a specified custom style.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identity of the workspace: AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Style learning ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'boolean', 'example' => 'xxx'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identity', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Whether the operation was successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Delete Custom writing style', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DocumentExtraction' => [ 'summary' => 'Extracts the content of documents from URLs.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Urls', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of URLs to extract.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'URL. Maximum length is 2048 characters.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/'], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Document object', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '作者'], 'Content' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'example' => '文章内容'], 'DocId' => ['title' => '', 'description' => 'Custom unique ID for the document', 'type' => 'string', 'example' => '文档-自定义的唯一ID'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique identifier for the document', 'type' => 'string', 'example' => '8df2d69d63a247b6b52ff455b2d426b6'], 'PubTime' => ['title' => '', 'description' => 'Publication time', 'type' => 'string', 'example' => '2024-05-14 08:54:33'], 'Source' => ['title' => '', 'description' => 'Source', 'type' => 'string', 'example' => '新闻来源'], 'Summary' => ['title' => '', 'description' => 'Article summary', 'type' => 'string', 'example' => '文章摘要'], 'Tag' => ['title' => '', 'description' => 'Tag', 'type' => 'string', 'example' => '文章标签'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '文章标题'], 'Url' => ['title' => '', 'description' => 'Article URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Document fetch', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:DocumentExtraction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'DownloadAuditNote' => [ 'summary' => 'Call this API to download the structured rule library for further processing. You can use this API to download either the structured rule library before post-processing or the structured rule library currently available for auditing. For specific usage, see the input parameter descriptions.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. Get the [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID obtained by calling the SubmitAuditNote API. This is the unique identifier for the custom rule library task index. Store it securely when using it. When using this API, if the input parameters include \\`taskId\\`, you can retrieve the structured rule library that you successfully uploaded via the SubmitAuditNote API but has not undergone post-processing by ConfirmAndProcessAuditNote. If the input parameters do not include \\`taskId\\`, you can retrieve the structured rule library that has undergone post-processing and is available for auditing.', 'type' => 'string', 'required' => false, 'example' => 'xxx_Default_1241541251241'], ], [ 'name' => 'NoteId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Rule library ID. If left blank, the default is Default.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Download link for the destination rule library.', 'type' => 'string', 'example' => 'http://download.xxx.yyy.zzz'], ], 'example' => '', ], ], ], '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\\": \\"http://download.xxx.yyy.zzz\\"\\n}","type":"json"}]', 'title' => 'Download Rule Library ', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:DownloadAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'DownloadBiddingDoc' => [ 'summary' => 'API for downloading bidding documents', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Operation result: true for success, false for failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '111_Default_20250708142918', 'title' => ''], 'Url' => ['description' => 'Document URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Download Bid Document File', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:DownloadBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'EditAuditTerms' => [ 'summary' => 'Edit custom audit term records.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of your Alibaba Cloud Model Studio workspace. Get your [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'Keyword', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Keyword', 'type' => 'string', 'example' => '龘', 'required' => false], ], [ 'name' => 'SuggestWord', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Suggested word', 'type' => 'string', 'example' => '龘(dá)', 'required' => false], ], [ 'name' => 'TermsDesc', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Audit rationale', 'type' => 'string', 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字，文字释义为群龙腾飞的样子，昂扬而热烈。', 'required' => false], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Primary key ID', 'type' => 'string', 'example' => '20103', 'required' => false], ], [ 'name' => 'ExceptionWord', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], 'description' => 'Exception statements', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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\\": true\\n}","type":"json"}]', 'title' => 'Edit a custom dictionary record ', 'changeSet' => [ ['createdAt' => '2025-08-15T05:32:39.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:EditAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'EditBiddingDoc' => [ 'summary' => 'Edits the content of a bidding document.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[The workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba', 'title' => ''], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['description' => 'The text content.', 'type' => 'string', 'required' => false, 'example' => '标书内容', 'title' => ''], ], [ 'name' => 'ContentType', 'in' => 'formData', 'schema' => ['description' => 'The content type.', 'type' => 'string', 'required' => false, 'example' => 'outline'."\n" .'bidding', 'title' => ''], ], [ 'name' => 'ContentFormat', 'in' => 'formData', 'schema' => ['description' => 'The format.', 'type' => 'string', 'required' => false, 'example' => 'html'."\n" .'markdown', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The business data.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Edit tender document content', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:EditBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ExportAnalysisTagDetailByTaskId' => [ 'summary' => 'Exports the tag details for a specified enterprise VOC analysis task.', 'path' => '', 'methods' => ['post', 'get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for Alibaba Cloud Model Studio workspace. For more information, see [Get Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique task ID.'."\n" ."\n" .'> By default, do not specify TaskId. The system automatically generates it. If subsequent tasks use the same TaskId, they belong to the same conversation group.', 'type' => 'string', 'required' => true, 'example' => 'xxx'], ], [ 'name' => 'Categories', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Category filter list.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Category filter.', 'type' => 'string', 'required' => false, 'example' => '分类1'], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Temporary accessible URL (expires in 1 hour).', 'type' => 'string', 'example' => 'http://www.example.com/xxx.xlsx'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Export label mining results', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportAnalysisTagDetailByTaskId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ExportAuditContentResult' => [ 'summary' => 'Exports an automated review report.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[The ID of the workspace.](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the task.', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'successful'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Data' => ['title' => '', 'description' => 'A publicly accessible URL for the exported Word file (.docx). The URL is valid for one hour.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.docx'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Export automated review report ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:ExportAuditContentResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ExportCustomSourceAnalysisTask' => [ 'summary' => 'Exports custom data source topic perspective analysis task results.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique ID for the task', 'type' => 'string', 'required' => true, 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2'], ], [ 'name' => 'ExportType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Export format type. Default is jsonLine. jsonline: Exports in jsonLine format. excel: Exports in Excel format.', 'type' => 'string', 'example' => 'jsonLine', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Publicly accessible URL', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jsonLine'."\n"], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Export Custom Source – Topic Analysis Job Result ', 'responseParamsDescription' => 'The file is returned in JSON Lines format. Each line is a JSON object. The JSON object format is as follows:'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| --------------------- | ------------------------- | -------------------------------------- |'."\n" .'| topic | string | Topic name |'."\n" .'| topicSummaryResult | array | List of topic summaries |'."\n" .'| hotViewPointsResult | HotViewPointsResult | Hot perspective analysis result |'."\n" .'| timedViewPointsResult | TimedViewPointsResult | Timeliness perspective analysis result |'."\n" .'| webReviewPointsResult | WebReviewPointsResult | User perspective analysis result |'."\n" .'| freshViewPointsResult | FreshViewPointsResult | Novel perspective analysis result |'."\n" ."\n" .'## TopicSummaryResult (Topic Summary)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------ | ----------------------- |'."\n" .'| summaries | array | List of topic summaries |'."\n" ."\n" .'### SummaryItem (Topic Summary)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | -------------- | ------------------------------------------- |'."\n" .'| title | string | Topic summary title |'."\n" .'| summary | string | Topic summary content |'."\n" .'| docList | array | List of documents referenced by the summary |'."\n" ."\n" .'### DocItem (Referenced Document)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ----------------- |'."\n" .'| title | string | Document title |'."\n" .'| url | string | Document link |'."\n" .'| source | string | Document source |'."\n" ."\n" .'## HotViewPointsResult (Hot Perspective Analysis Result)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------------------- | ------------------------ |'."\n" .'| attitudes | array | List of hot perspectives |'."\n" ."\n" .'### HotAttitudeItem (Hot Perspective)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ------------ | ----------------------- | ------------------------------------------------------ |'."\n" .'| attitude | string | Hot perspective |'."\n" .'| attitudeType | string | Hot perspective type |'."\n" .'| news | array | List of articles referenced by the hot perspective |'."\n" .'| ratio | string | Proportion of this hot perspective in the entire topic |'."\n" .'| viewPoints | array | List of planning proposals for hot perspectives |'."\n" ."\n" .'### HotNewsItem (Articles Referenced by Hot Perspective)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ----------------- |'."\n" .'| title | string | Article title |'."\n" .'| url | string | Article link |'."\n" .'| source | string | Article source |'."\n" ."\n" .'### HotViewPointItem (Hot Perspective Topic Selection)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------ | --------------------------------------- |'."\n" .'| point | string | Topic planning direction |'."\n" .'| summary | string | Summary of the topic planning direction |'."\n" .'| outlines | array | Outline of the topic planning direction |'."\n" ."\n" .'### OutlineItem'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ----------------- |'."\n" .'| outline | string | Outline title |'."\n" .'| summary | string | Outline summary |'."\n" ."\n" .'## TimedViewPointsResult (Timeliness Perspective Analysis Result)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------------ | ------------------------------- |'."\n" .'| attitudes | array | List of timeliness perspectives |'."\n" ."\n" .'### TimedAttitudeItem (Timeliness Perspective)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------------- | ------------------------------------------------------ |'."\n" .'| docUuid | string | Unique news identifier |'."\n" .'| title | string | News title |'."\n" .'| url | string | News link |'."\n" .'| source | string | News source |'."\n" .'| pubTime | string | News publication time |'."\n" .'| viewPoints | array | List of planning proposals for timeliness perspectives |'."\n" ."\n" .'### TimedViewPointItem (Timeliness Perspective Topic Selection)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------ | --------------------------------------- |'."\n" .'| point | string | Topic planning direction |'."\n" .'| summary | string | Summary of the topic planning direction |'."\n" .'| outlines | array | Outline of the topic planning direction |'."\n" ."\n" .'### OutlineItem'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ----------------- |'."\n" .'| outline | string | Outline title |'."\n" .'| summary | string | Outline summary |'."\n" ."\n" .'## WebReviewPointsResult (User Perspective Analysis Result)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------------------------- | ------------------------- |'."\n" .'| attitudes | array | List of user perspectives |'."\n" ."\n" .'### WebReviewAttitudeItem (User Perspective)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ------------ | ----------------------------- | ------------------------------------------------------- |'."\n" .'| attitude | string | User perspective |'."\n" .'| attitudeType | string | User perspective type |'."\n" .'| ratio | string | Proportion of this user perspective in the entire topic |'."\n" .'| comments | array | List of user comments |'."\n" .'| viewPoints | array | List of planning proposals for user perspectives |'."\n" ."\n" .'### WebReviewCommentItem (User Comments)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ---------------------------------- |'."\n" .'| text | string | User comment |'."\n" .'| source | string | Source of user comment |'."\n" .'| url | string | News link for user comment source |'."\n" .'| title | string | News title for user comment source |'."\n" ."\n" .'### WebReviewViewPointItem (User Perspective Topic Selection)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------ | --------------------------------------- |'."\n" .'| point | string | Topic planning direction |'."\n" .'| summary | string | Summary of the topic planning direction |'."\n" .'| outlines | array | Outline of the topic planning direction |'."\n" ."\n" .'### OutlineItem'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ----------------- |'."\n" .'| outline | string | Outline title |'."\n" .'| summary | string | Outline summary |'."\n" ."\n" .'## FreshViewPointsResult'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------------ | -------------------------- |'."\n" .'| attitudes | array | List of novel perspectives |'."\n" ."\n" .'### FreshAttitudeItem (Novel Perspective)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------------- | ------------------------------------------------- |'."\n" .'| viewPoints | array | List of planning proposals for novel perspectives |'."\n" ."\n" .'### FreshViewPointItem (Novel Perspective Topic Selection)'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ------------------ | --------------------------------------- |'."\n" .'| point | string | Topic planning direction |'."\n" .'| summary | string | Summary of the topic planning direction |'."\n" .'| outlines | array | Outline of the topic planning direction |'."\n" ."\n" .'### OutlineItem'."\n" ."\n" .'| Field Name | Field Type | Field Description |'."\n" .'| ---------- | ---------- | ----------------- |'."\n" .'| outline | string | Outline title |'."\n" .'| summary | string | Outline summary |', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportCustomSourceAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ExportGeneratedContent' => [ 'summary' => 'Exports the history of articles created in MiaoBi.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Workspace identity: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Document identity', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'string', 'example' => 'xxx'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Request identity', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Operation result: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Export Document', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ExportGeneratedContent'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ExportHotTopicPlanningProposals' => [ 'summary' => 'Exports topic planning documents and provides a publicly accessible URL that expires in one hour.', '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' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'ExportType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Document export format'."\n" ."\n" .'- word: Export as a Word document'."\n" ."\n" .'- xmind: Export as an XMind file', 'type' => 'string', 'example' => 'word', 'required' => false], ], [ 'name' => 'Titles', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Filter topic planning documents by title', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Filter topic planning documents by title', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxx'], 'required' => false, 'example' => '', ], ], [ 'name' => 'ViewPointType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Topic planning type'."\n" ."\n" .'- CustomViewPoints: Custom viewpoint'."\n" ."\n" .'- HotViewPoints: Popular viewpoint'."\n" ."\n" .'- TimedViewPoints: Time-sensitive viewpoint'."\n" ."\n" .'- WebReviewPoints: Public viewpoint'."\n" ."\n" .'- FreshViewPoints: Fresh viewpoint', 'type' => 'string', 'example' => 'CustomViewPoints', 'required' => false], ], [ 'name' => 'CustomViewPointIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Custom viewpoint ID. Use this parameter for custom viewpoint topic planning.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Custom viewpoint ID. Use this parameter for custom viewpoint topic planning.', 'type' => 'string', 'example' => '7d9139c4fd884be3b5db584c28501813', 'required' => false], 'required' => false, 'example' => '025c6cee437741368098b790c90166f8', ], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot list source', 'type' => 'string', 'required' => true, 'example' => '热榜源'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot list topic', 'type' => 'string', 'required' => true, 'example' => '热榜主题'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => '', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Publicly accessible URL. Expires in one hour.', 'type' => 'string', 'example' => '业务数据'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Operation status. Set to true for success or false for failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Export topic planning document', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportHotTopicPlanningProposals', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ExportIntervenes' => [ 'summary' => 'Exports all interventions.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fed6555ec9e24b92aeecc34be484b887_p_efm'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'FileUrl' => ['title' => '', 'description' => 'File URL', 'type' => 'string', 'example' => 'http://xxx/xxx.xls'], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Success status: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Export intervention item content', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ExportIntervenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'ExportPptArtifact' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxx'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], [ 'name' => 'PptArtifactId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the PPT artifact.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123123'], ], [ 'name' => 'ExportFileType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The export file type.', 'type' => 'string', 'example' => 'ppt', 'default' => 'ppt', 'enum' => ['ppt', 'png', 'jpeg', 'pdf'], 'required' => false, ], ], [ 'name' => 'Edit', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Indicates if the exported artifact is editable.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'Zip', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Indicates if the exported file is compressed into a ZIP package.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The data returned.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Whether the request succeeded.', 'type' => 'boolean', 'example' => ''], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The export task details.', 'title' => '', 'type' => 'object', 'properties' => [ 'ExportTaskId' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'string', 'example' => 'adb8146b-146b-4206-bd40-19f591e85293'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Export PPT work ', 'summary' => 'Exports a PPT artifact.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:ExportPptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": false,\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Message\\": \\"错误消息\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": {\\n \\"ExportTaskId\\": \\"adb8146b-146b-4206-bd40-19f591e85293\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'FeedbackDialogue' => [ 'summary' => 'Provides feedback on the quality of the content that the model generates.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique ID of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the page.', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of a single-turn conversation.', 'type' => 'string', 'required' => true, 'example' => '75bf82fa-b71b-45d7-ae40-0b00e496cd9e'], ], [ 'name' => 'Rating', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'thumbsDown: Dislike, thumbsUp: Like', 'enumValueTitles' => ['thumbsDown' => 'Dislike', 'thumbsUp' => 'Like'], 'type' => 'string', 'required' => false, 'example' => 'thumbsDown', ], ], [ 'name' => 'RatingTags', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The tags.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A feedback tag. It can be any string of up to 20 characters.', 'type' => 'string', 'required' => false, 'example' => '生成内容跟要求不符（跟主题不符）', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'ModifiedResponse', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The modified generated result.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'CustomerResponse', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The feedback.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ 'name' => 'GoodText', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The generated content that is considered good.', 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'BaseResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Submit Conversation Feedback', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'FetchExportTermsTask' => [ 'summary' => 'Retrieves the results of a term library export task.', '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' => '', 'description' => 'The unique identifier of your Alibaba Cloud Model Studio workspace. To get your [Workspace ID](~~2782167~~), see the referenced document.', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileUrl' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'https//xxxx'], 'Status' => ['title' => '', 'description' => 'The task execution status.', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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 \\"FileUrl\\": \\"https//xxxx\\",\\n \\"Status\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain the result of a vocabulary export job ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:FetchExportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'FetchExportWordTask' => [ 'summary' => 'Fetches the result of an asynchronous document export task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '2e27abb32cb64f80a0c6e829b6c87a09', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'FileUrl' => ['description' => 'The file URL.', 'type' => 'string', 'example' => 'http://xxx/xxx.xls', 'title' => ''], 'TaskStats' => ['description' => 'The status of the task.', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\`: successful. \\`false\\`: failed.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Obtain the result of a document export job ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:FetchExportWordTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'FetchImageTask' => [ 'summary' => 'Retrieve the results of image generation tasks.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'], ], [ 'name' => 'TaskIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of task IDs', 'title' => '', 'type' => 'array', 'items' => ['description' => 'TaskId, the unique identifier of a task'."\n" ."\n" .'> You do not need to specify TaskId by default. The system generates it automatically. When multiple tasks use the same TaskId, they belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => '9c5ac65f-fcac-416c-81d0-4ab81e1373fd', 'title' => ''], 'required' => true, 'example' => '["9d8c9185-3f75-4a20-aca1-c5bb53dd97b3"]', ], ], [ 'name' => 'ArticleTaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Article task ID', 'type' => 'string', 'required' => true, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskInfoList' => [ 'description' => 'Image information generated by smart illustration tasks', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Paragraph ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ImageList' => [ 'description' => 'Image information', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Error code returned if the image was not generated', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Error message returned if the image was not generated', 'type' => 'string', 'example' => '错误'], 'Url' => ['title' => '', 'description' => 'Image URL', 'type' => 'string', 'example' => 'http://www.example.com/aaa.png'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TaskId' => ['title' => '', 'description' => 'Task ID, the unique identifier of a task', 'type' => 'string', 'example' => 'net-7eb32699000d4193a3c59fc64ae1e55f'], 'TaskStatus' => ['title' => '', 'description' => 'Current task status. Values: SUCCESSED = task succeeded, FAILED = task failed, CANCELED = task canceled, PENDING = task queued, SUSPENDED = task suspended, RUNNING = task in progress', 'type' => 'string', 'example' => 'SUCCESSED'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve Image Job Execution Result', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'FetchImageTask'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:FetchImageTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'FetchImportTermsTask' => [ 'summary' => 'Retrieves the result of a term import task.', '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' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The FileKey of the file.', 'type' => 'string', 'required' => true, 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'The execution status of the task.', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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 \\"Status\\": \\"PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消\\"\\n }\\n}","type":"json"}]', 'title' => 'Obtain the result of the import dictionary job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:FetchImportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'FetchParseDocumentLayoutTask' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace: [Get workspaceId](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Content to be formatted', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '29ae0ba84c1c4cc694d0f4f1aead8005'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the call succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'TaskStats' => ['description' => 'Task status', 'type' => 'string', 'example' => 'PENDING-待执行、RUNNING-执行中、SUCCESSED-成功、SUSPENDED-暂停、FAILED-失败、CANCELLED-取消', 'title' => ''], 'LayoutResult' => [ 'type' => 'object', 'properties' => [ 'Elements' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Index' => ['description' => 'Index order of each element', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], '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("引用");', 'title' => ''], 'Content' => ['description' => 'Content', 'type' => 'string', 'example' => '一、本月主要工作进展\\n', 'title' => ''], 'FormatContent' => ['description' => 'For headings, content with heading numbers removed', 'type' => 'string', 'example' => '本月主要工作进展', 'title' => ''], ], 'description' => 'Array object', 'title' => '', 'example' => '', ], 'description' => 'Returned element data', 'title' => '', 'example' => '', ], ], 'description' => 'Structured content after formatting', 'title' => '', 'example' => '', ], ], 'description' => 'Business data', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Schema of Response', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'FetchParseDocumentLayoutTask', 'summary' => 'Retrieve the layout task result.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], '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"}]', 'translator' => 'machine', ], 'GenerateExportWordTask' => [ 'summary' => 'Start a task to export content as a Word document.', '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' => '', 'description' => 'Unique identifier of the workspace: AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'GeneratedContentId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the document', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Generate a job to export a document ', 'description' => 'The Quanmiao product supports iframe embedding. For details, see [Customer Integration: Quanmiao Public Cloud iframe Customization Guide](~~3000990~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GenerateExportWordTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GenerateFileUrlByKey' => [ 'summary' => 'Generate a temporary public 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' => '', 'description' => 'Unique workspace identity: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'File key. Format: protocol://serverInstance/bucketPath/fileKey', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx', 'required' => false], ], [ 'name' => 'FileName', 'in' => 'formData', 'schema' => ['description' => 'File name', 'type' => 'string', 'required' => false, 'example' => 'test.docx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'successful'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'string', 'example' => 'https://www.example.com/a.txt'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Generate File URL', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ['createdAt' => '2024-03-04T09:44:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateFileUrlByKey'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GenerateFileUrlByKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GenerateImageTask' => [ 'summary' => 'Asynchronously generates an image from text.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'."\n"], ], [ 'name' => 'ParagraphList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The content of the paragraphs.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content of the paragraph.', 'type' => 'string', 'required' => true, 'example' => '一直忧伤的猫'], 'Id' => ['title' => '', 'description' => 'The paragraph ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], 'TaskId' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> By default, you do not need to specify this parameter. The system automatically generates a task ID. If you specify the same TaskId for subsequent tasks, these tasks are considered part of the same conversation group.', 'type' => 'string', 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3', 'required' => false], 'TaskStatus' => ['title' => '', 'description' => 'The current status of the task.'."\n" ."\n" .'- PENDING: The task is in the queue.'."\n" ."\n" .'- RUNNING: The task is in progress.'."\n" ."\n" .'- SUSPENDED: The task is suspended.'."\n" ."\n" .'- SUCCEEDED: The task was successful.'."\n" ."\n" .'- FAILED: The task failed.'."\n" ."\n" .'- UNKNOWN: The task does not exist or its status is unknown.', 'type' => 'string', 'example' => 'SUCCESSED', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], [ 'name' => 'Style', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The style.', 'enumValueTitles' => ['' => 'Portrait photography', '' => 'Default style', '<3d cartoon>' => '3D cartoon', 'watercolor' => 'Watercolor', '' => 'Photography', '' => 'Flat illustration', '' => 'Sketch', '' => 'Oil painting', '' => 'Chinese painting', '' => 'Animation'], 'type' => 'string', 'required' => true, 'example' => '\'\'', ], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The size of the image to generate.', 'enumValueTitles' => ['1024*1024' => '1024\\*1024', '720*1280' => '720\\*1280', '1280*720' => '1280\\*720'], 'type' => 'string', 'required' => true, 'example' => '1024*1024', ], ], [ 'name' => 'ArticleTaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID of the article. If you do not have one, you can assign a universally unique identifier (UUID).', 'type' => 'string', 'required' => true, 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskList' => [ 'description' => 'The information about the paragraph tasks. The tasks are associated based on the input paragraph IDs.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The paragraph object.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content of the paragraph.', 'type' => 'string', 'example' => '一直忧伤的猫'], 'Id' => ['title' => '', 'description' => 'The paragraph ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'TaskId' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'example' => 'e1be065b-adc3-435e-bd01-1c18c5ed75d3'], 'TaskStatus' => ['title' => '', 'description' => 'The current status of the task. Valid values: SUCCEEDED, FAILED, CANCELED, PENDING, SUSPENDED, and RUNNING.', 'type' => 'string', 'example' => 'SUCCESSED'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Generate Intelligent Image Generation Job ', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateImageTask'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GenerateImageTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GenerateUploadConfig' => [ 'summary' => 'Generates a file upload configuration.'."\n" .'1\\. Call this API to obtain the upload configuration. The API returns the `PostUrl` (an internal OSS address for AI Writing Assistant), temporary OSS authentication information (`key`, `OSSAccessKeyId`, `Signature`, and `policy`), and the unique file identifier `fileKey`.'."\n" .'2\\. The client uses the `PostUrl` and the temporary authentication information (`key`, `OSSAccessKeyId`, `Signature`, and `policy`) to upload the file.'."\n" .'3\\. Use the `fileKey` to call subsequent APIs that require a `fileKey`, such as `GenerateFileUrlByKey`.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'FileName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The file name.', 'type' => 'string', 'example' => 'test.docx', 'required' => false], ], [ 'name' => 'ParentDir', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The parent folder.'."\n" ."\n" .'- materialDocument: The Material Library for AI Writing Assistant.'."\n" ."\n" .'- datasetUpload: The dataset for AI Search.'."\n" ."\n" .'- intervenes: Interventions.'."\n" ."\n" .'- temp: A temporary upload folder. Files in this folder are released periodically.', 'type' => 'string', 'required' => true, 'example' => 'dataset', 'enum' => ['materialDocument', 'intervenes', 'temp', 'imageGenerate', 'datasetUpload', 'deepWrite'], ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileKey' => ['title' => '', 'description' => 'The unique identifier of the file. You can use this value as a URL for AI Writing Assistant.', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'], 'FormDatas' => [ 'description' => 'The credentials for uploading the file to OSS.'."\n" ."\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" .'```', 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', 'type' => 'object', 'example' => '', ], 'PostUrl' => ['title' => '', 'description' => 'The address for uploading the file to OSS. This is a dedicated OSS domain name for AI Writing Assistant. The value is fixed to \\`https\\://aimiaobi-service-prod.oss-cn-beijing.aliyuncs.com/\\`.', 'type' => 'string', 'example' => 'https://aimiaobi-service-prod.oss-cn-beijing.aliyuncs.com/'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Generate upload configuration ', 'description' => 'This API returns the address and credentials for file uploads. For more information, see [OSS Form Upload](https://help.aliyun.com/zh/oss/user-guide/form-upload?scm=20140722.H_31849._.OR_help-T_cn~zh-V_1).', 'responseParamsDescription' => '## Upload the file'."\n" ."\n" .'After you obtain the \\`PostUrl\\` (the internal OSS for AI Writing Assistant) and \\`FormDatas\\` (temporary OSS authentication) parameters, upload the file to OSS.'."\n" ."\n" .'> This is the core upload step and is required. After the upload is complete, use the \\`fileKey\\` in subsequent API calls.'."\n" ."\n" .'The following is a sample cURL request:'."\n" ."\n" .'> This is a simple cURL example. For software development kit (SDK) integration, you typically write code to upload the file from a form.'."\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' => 'Request parameters changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2024-03-04T09:44:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateUploadConfig'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GenerateUploadConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GenerateViewPoint' => [ 'summary' => 'Generates viewpoints from article snippets.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The context data.', 'title' => '', 'type' => 'object', 'properties' => [ 'MiniDoc' => [ 'description' => 'The article snippets.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'An article snippet.', 'type' => 'string', 'required' => false, 'example' => '文章片段', 'title' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '200'], 'Data' => [ 'description' => 'The response data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An object that contains a viewpoint.', 'type' => 'object', 'properties' => [ 'Point' => ['title' => '', 'description' => 'The viewpoint text.', 'type' => 'string', 'example' => '视角'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The response message. The value is `successful` on success, or an error message on failure.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Generate topic perspectives', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GenerateViewPoint'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:GenerateViewPoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetAuditNotePostProcessingStatus' => [ 'summary' => 'Queries the progress of a post-processing task for a rule library. Use this operation together with the ConfirmAndPostProcessAuditNote operation to check the status of the current post-processing task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID returned by the SubmitAuditNote operation. This is the unique identifier for the task index of the custom rule library. Save this ID for future use.', 'type' => 'string', 'required' => true, 'example' => 'xxx_Default_12847192741412'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'required' => true, 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'required' => true, 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'required' => true, 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error details.', 'type' => 'string', 'required' => true, 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'NoteId' => ['title' => '', 'description' => 'The ID of the rule library. The default value in the current version is "Default".', 'type' => 'string', 'example' => 'Default'], 'Status' => ['title' => '', 'description' => 'The status of the post-processing task. Valid values: PENDING, RUNNING, SUCCEEDED, and FAILED.', 'type' => 'string', 'example' => 'RUNNING'], 'TotalLines' => ['title' => '', 'description' => 'The total number of lines in the structured rule library.', 'type' => 'integer', 'format' => 'int32', 'example' => '666'], 'ProcessedLines' => ['title' => '', 'description' => 'The number of lines that have been post-processed.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '233'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message. This is returned only when the post-processing task fails.', 'type' => 'string', 'example' => 'error'], 'CreateTime' => ['title' => '', 'description' => 'The time when the post-processing task was created. The format is YYYY-MM-DD HH:mm:ss.', 'type' => 'string', 'example' => '1970-01-01 12:34:56'], 'CompletionTime' => ['title' => '', 'description' => 'The time when the post-processing task was completed. The format is YYYY-MM-DD HH:mm:ss.', 'type' => 'string', 'example' => '1970-01-01 23:34:45'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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 \\"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' => 'Retrieve the post-processing progress of the rule library', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAuditNotePostProcessingStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetAuditNoteProcessingStatus' => [ 'summary' => 'Checks the processing status of an uploaded rule library. This operation returns the current status of the upload task, the size of the parsed rule library file, and its storage path.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of your Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Task ID returned by the SubmitAuditNote operation. Save this ID securely. It uniquely identifies your custom rule library task.', 'type' => 'string', 'required' => true, 'example' => 'xxx_Default_129873419274'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'Response data', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'Task status. Valid values: PENDING, RUNNING, SUCCESSED, or FAILED', 'type' => 'string', 'example' => 'SUCCESSED'], 'UpdateTime' => ['description' => 'Update time', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-11-25 11:40:50', 'title' => ''], 'TaskId' => ['title' => '', 'description' => 'Task ID. Unique identifier for this task.', 'type' => 'string', 'example' => '111_Default_20250708142918'], 'FileKey' => ['title' => '', 'description' => 'OSS path where the parsed rule library is stored', 'type' => 'string', 'example' => 'oss://default/path/to/audit/note'], 'FileSize' => ['description' => 'Size of the rule library file, in bytes', 'type' => 'integer', 'format' => 'int64', 'example' => '504', 'title' => ''], 'NoteName' => ['title' => '', 'description' => 'Name of the parsed rule library', 'type' => 'string', 'example' => '错题本2025-07-07_解析结果'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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 \\"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' => 'Query the upload status of a rule library', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAuditNoteProcessingStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetAutoClipsTaskInfo' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Unique ID of the task.', 'type' => 'string', 'required' => true, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba', 'title' => ''], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Workspace](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => '百炼工作空间Id', 'title' => ''], ], [ 'name' => 'ShowResourceInfo', 'in' => 'formData', 'schema' => ['description' => 'Show video source information.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ 'name' => 'ShowAnalysisResults', 'in' => 'formData', 'schema' => ['description' => 'Show video understanding results.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'Business data.', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Unique ID of the task.', 'type' => 'string', 'example' => 'e5a1a59c82d0454fad6454e8a04d0093', 'title' => ''], 'Step' => ['description' => 'Current step.', 'type' => 'string', 'example' => 'clips', 'title' => ''], 'Status' => ['description' => 'Status', 'type' => 'integer', 'format' => 'int32', 'example' => '0-待执行、1-执行中、2-执行成功、3-暂停、4-执行失败-可重试、5-执行失败-不可重试,6-任务取消', 'title' => ''], 'Content' => ['description' => 'Full voiceover script.', 'type' => 'string', 'example' => '口播内容', 'title' => ''], 'Timelines' => [ 'description' => 'Array of voiceover timelines.', 'type' => 'array', 'items' => [ 'description' => 'Voiceover timeline.', 'type' => 'object', 'properties' => [ 'TimelineId' => ['description' => 'ID of the timeline.', 'type' => 'string', 'example' => '20774ebd9abc71ef80486632b68f0102', 'title' => ''], 'Content' => ['description' => 'Voiceover script.', 'type' => 'string', 'example' => '口播内容', 'title' => ''], 'Clips' => [ 'description' => 'Array of video clips.', 'type' => 'array', 'items' => [ 'description' => 'Video clip.', 'type' => 'object', 'properties' => [ 'ClipId' => ['description' => 'ID of the clip.', 'type' => 'string', 'example' => '20774ebd9abc71ef80486632b68f0102'."\n", 'title' => ''], 'VideoName' => ['description' => 'Name of the video.', 'type' => 'string', 'example' => '123.mp4', 'title' => ''], 'VideoId' => ['description' => 'ID of the video.', 'type' => 'string', 'example' => '20774ebd9abc71ef80486632b68f0102', 'title' => ''], 'In' => ['description' => 'Start time of the clip in seconds. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'Out' => ['description' => 'End time of the clip in seconds. This field is deprecated.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'ContentInner' => ['description' => 'Segmented voiceover script.', 'type' => 'string', 'example' => '口播分段内容', 'title' => ''], 'InEx' => ['description' => 'Start time of the clip in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '0.33', 'title' => ''], 'OutEx' => ['description' => 'End time of the clip in milliseconds.', 'type' => 'number', 'format' => 'float', 'example' => '3.45', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'VoiceStyle' => ['description' => 'Voice style for voiceover.', 'type' => 'string', 'example' => '温柔女声', 'title' => ''], 'MusicStyle' => ['description' => 'Recommended music style.', 'type' => 'string', 'example' => '国风', 'title' => ''], 'MusicUrl' => ['description' => 'URL of the background music.', 'type' => 'string', 'example' => 'http://music.mp4', 'title' => ''], 'MusicVolume' => ['description' => 'Volume of the background music.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'VoiceVolume' => ['description' => 'Volume of the voiceover.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'SubtitleFontSize' => ['description' => 'Font size of subtitles.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'OutputVideoUrl' => ['description' => 'URL of the final video.', 'type' => 'string', 'example' => 'http://output.mp4', 'title' => ''], 'MediaCloudTimeline' => ['description' => 'ApsaraVideo timeline.', 'type' => 'string', 'example' => '视频云格式timeline', 'title' => ''], 'ColorWords' => [ 'description' => 'Array of decorative text elements.', 'type' => 'array', 'items' => [ 'description' => 'Decorative text element.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Text content.', 'type' => 'string', 'example' => '花字内容', 'title' => ''], 'TimelineIn' => ['description' => 'Start time of the decorative text in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'TimelineOut' => ['description' => 'End time of the decorative text in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'X' => ['description' => 'X-coordinate of the decorative text.', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'title' => ''], 'Y' => ['description' => 'Y-coordinate of the decorative text.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], 'FontSize' => ['description' => 'Font size of the decorative text.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], 'EffectColorStyle' => ['description' => 'Visual effect of the decorative text.', 'type' => 'string', 'example' => 'CS0002-000008', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => '错误信息', 'title' => ''], 'CloseVoice' => ['title' => '', 'description' => 'Disable voiceover.', 'type' => 'boolean', 'example' => ''], 'CloseSubtitle' => ['title' => '', 'description' => 'Disable subtitles.', 'type' => 'boolean', 'example' => ''], 'CloseMusic' => ['title' => '', 'description' => 'Disable background music.', 'type' => 'boolean', 'example' => ''], 'CustomVoiceUrl' => ['title' => '', 'description' => 'URL of the custom audio track file.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4'], 'CustomVoiceVolume' => ['title' => '', 'description' => 'Volume of the custom audio track.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Stickers' => [ 'description' => 'Array of stickers.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Sticker structure.', 'title' => '', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'URL of the sticker GIF file.', 'type' => 'string', 'example' => 'http://xxx/xxx.gif'], 'TimelineIn' => ['title' => '', 'description' => 'Start time of the sticker in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Duration' => ['title' => '', 'description' => 'Duration of the sticker display.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'X' => ['title' => '', 'description' => 'X-coordinate of the sticker position.', 'type' => 'number', 'format' => 'float', 'example' => '100'], 'Y' => ['title' => '', 'description' => 'Y-coordinate of the sticker position.', 'type' => 'number', 'format' => 'float', 'example' => '100'], 'Width' => ['title' => '', 'description' => 'Width of the sticker.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Height' => ['title' => '', 'description' => 'Height of the sticker.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'DyncFrames' => ['title' => '', 'description' => 'Height of the sticker', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], ], 'example' => '', ], 'example' => '', ], 'CustomVoiceStyle' => ['description' => 'Voice style for CosyVoice.', 'type' => 'string', 'example' => 'longxian_normal', 'title' => ''], 'OutputVideoFileKey' => ['description' => 'File key of the output video.', 'type' => 'string', 'example' => 'oss://xxx/xxx.mp4', 'title' => ''], 'OpeningCreditsUrl' => ['description' => 'URL of the opening credits video.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'title' => ''], 'ClosingCreditsUrl' => ['description' => 'URL of the closing credits video.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'title' => ''], 'SourceVideos' => [ 'description' => 'List of video sources used for editing.', 'type' => 'array', 'items' => [ 'description' => 'Video source structure.', 'type' => 'object', 'properties' => [ 'VideoId' => ['description' => 'Video ID.', 'type' => 'string', 'example' => 'fdaswe', 'title' => ''], 'VideoName' => ['description' => 'Video name.', 'type' => 'string', 'example' => 'video001.mp4', 'title' => ''], 'VideoUrl' => ['description' => 'Video URL.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ReferenceVideo' => [ 'description' => 'Reference video information.', 'type' => 'object', 'properties' => [ 'VideoId' => ['description' => 'Video ID.', 'type' => 'string', 'example' => '90ca686b11c371f08339752281ed0102', 'title' => ''], 'VideoName' => ['description' => 'Video name.', 'type' => 'string', 'example' => 'video001.mp4', 'title' => ''], 'VideoUrl' => ['description' => 'Video URL.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AnalysisResults' => [ 'description' => 'List of video understanding results.', 'type' => 'array', 'items' => [ 'description' => 'Video understanding result.', 'type' => 'object', 'properties' => [ 'MediaId' => ['description' => 'Video ID.', 'type' => 'string', 'example' => '975e1d91a8d057e132cc5d88e4d5b360', 'title' => ''], 'MediaName' => ['description' => 'Video name.', 'type' => 'string', 'example' => 'video001.mp4', 'title' => ''], 'MediaUrl' => ['description' => 'Video URL.', 'type' => 'string', 'example' => 'http://xxx/xxx.mp4', 'title' => ''], 'LensInfos' => [ 'description' => 'List of shot information.', 'type' => 'array', 'items' => [ 'description' => 'Shot information.', 'type' => 'object', 'properties' => [ 'StartTime' => [ 'description' => 'Start time.', 'type' => 'object', 'properties' => [ 'Hour' => ['description' => 'Hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'Minute' => ['description' => 'Minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Second' => ['description' => 'Second.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'MillSecond' => ['description' => 'Millisecond.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'EndTime' => [ 'description' => 'End time.', 'type' => 'object', 'properties' => [ 'Hour' => ['description' => 'Hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], 'Minute' => ['description' => 'Minute.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Second' => ['description' => 'Second.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], 'MillSecond' => ['description' => 'Millisecond.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'title' => '', 'example' => '', ], 'AnalysisContent' => ['description' => 'Content analysis', 'type' => 'string', 'example' => '视频理解内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'title' => '', 'format' => 'int32', 'example' => '200'], 'Message' => ['description' => 'Error description.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain video editing Job information ', 'summary' => 'Retrieves the status of a video editing task.', 'changeSet' => [ ['createdAt' => '2025-08-01T09:22:18.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-07-24T11:29:28.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAutoClipsTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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\\": false,\\n \\"CloseSubtitle\\": false,\\n \\"CloseMusic\\": false,\\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"}]', 'translator' => 'machine', ], 'GetAvailableAuditNotes' => [ 'summary' => 'Query the rule libraries that are currently available for audit. This operation returns only rule libraries that are active for auditing. To view the contents of a custom rule library, use the DownloadAuditNote API.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of your Alibaba Cloud Model Studio workspace. Get your [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'NoteId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The rule library ID. If not specified, defaults to Default.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'Response data', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Primary ID of the rule library storage.', 'type' => 'string', 'example' => '1'], 'NoteId' => ['title' => '', 'description' => 'Rule library ID.', 'type' => 'string', 'example' => 'Default'], 'UpdateTime' => ['title' => '', 'description' => 'Rule library update time.', 'type' => 'string', 'example' => '2025-07-07 11:56:30'], 'FileSize' => ['title' => '', 'description' => 'Rule library file size in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '23333'], 'NoteName' => ['title' => '', 'description' => 'Parsed rule library name.', 'type' => 'string', 'example' => '错题本2025-07-07_解析结果'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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 \\"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' => 'Query active rule libraries', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAvailableAuditNotes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetBiddingDocInfo' => [ 'summary' => 'Retrieves the generation results of a bidding document.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error description', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'Step' => ['description' => 'Current status', 'type' => 'string', 'example' => 'analysis'."\n" .'writing', 'title' => ''], 'Status' => ['description' => 'Task status', 'type' => 'integer', 'format' => 'int32', 'example' => '0-waiting、1-running、2-success、3-pause、4-fail'."\n", 'title' => ''], 'Content' => ['description' => 'Bidding document content', 'type' => 'string', 'example' => '文章内容', 'title' => ''], 'ContentType' => ['description' => 'File type.', 'type' => 'string', 'example' => 'outline'."\n" .'bidding', 'title' => ''], 'ContentFormat' => ['description' => 'Format', 'type' => 'string', 'example' => 'markdown'."\n" .'html', 'title' => ''], 'TenderDocUrl' => ['description' => 'Tender document URL', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], 'TenderFileType' => ['description' => 'Tender document file type', 'type' => 'string', 'example' => 'pdf'."\n" .'docx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Obtain Bid Writing Result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetBiddingDocInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetBiddingRemainLimitNum' => [ 'summary' => 'Retrieve the remaining limit for the bidding feature.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''], ], [ 'name' => 'ApiName', 'in' => 'formData', 'schema' => ['description' => 'API name', 'type' => 'string', 'required' => false, 'example' => 'asyncUploadTenderDoc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Fault message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'True', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'RemainNum' => ['description' => 'Remaining quantity', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain the remaining quota for tender document writing', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetBiddingRemainLimitNum', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetCategoriesByTaskId' => [ 'summary' => 'Retrieves the classifications from a tag mining task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> You do not need to specify this parameter. The system automatically generates a task ID. If you specify the same task ID for subsequent tasks, the tasks are considered part of the same conversation group.', 'type' => 'string', 'required' => true, 'example' => 'xxx'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: \\`true\\` and \\`false\\`.', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => 'A list of classification objects.', 'type' => 'array', 'items' => [ 'description' => 'A classification object.', 'type' => 'object', 'properties' => [ 'Category' => ['description' => 'The name of the classification.', 'type' => 'string', 'example' => '类别1', 'title' => ''], 'Children' => [ 'description' => 'A list of sub-classifications.', 'type' => 'array', 'items' => [ 'description' => 'A sub-classification object.', 'type' => 'object', 'properties' => [ 'Category' => ['description' => 'The name of the sub-classification.', 'type' => 'string', 'example' => '类别1-1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Count' => ['title' => '', 'description' => 'The number of Voice of the Customer (VOC) entries in this classification.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"NoData\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"1813ceee-7fe5-41b4-87e5-982a4d18cca5\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Category\\": \\"类别1\\",\\n \\"Children\\": [\\n {\\n \\"Category\\": \\"类别1-1\\"\\n }\\n ],\\n \\"Count\\": 2\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Retrieve categorization list by job ID', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCategoriesByTaskId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetClipsBuildInResource' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the Alibaba Cloud Model Studio workspace.', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq', 'title' => ''], ], [ 'name' => 'ResourceType', 'in' => 'formData', 'schema' => ['description' => 'The resource type.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0 - 音色'."\n" .'1- 背景音', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'ResourceType' => ['description' => 'The resource type.', 'type' => 'integer', 'format' => 'int32', 'example' => '0 - 音色'."\n" .'1- 背景音', 'title' => ''], 'ResourceList' => [ 'description' => 'The list of resources.', 'type' => 'array', 'items' => ['description' => 'The list of resources.', 'type' => 'string', 'example' => '轻快', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of true means the request was successful. A value of false means the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve Intelligent Video Editing built-in resources ', 'summary' => 'Retrieves the built-in resources for smart clipping.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetClipsBuildInResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetCustomHotTopicBroadcastJob' => [ 'summary' => 'Retrieves the result of a custom hot topic broadcast job.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> Tasks that use the same TaskId belong to the same conversation group.', 'type' => 'string', 'required' => true, 'example' => '2e27abb32cb64f80a0c6e829b6c87a09'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'HotTopicVersion' => ['title' => '', 'description' => 'The version number of the hot topic.', 'type' => 'string', 'example' => '热点话题版本号标识'], 'Status' => [ 'title' => '', 'description' => 'The status of the task.'."\n" ."\n" .'- PENDING: The task is pending.'."\n" ."\n" .'- RUNNING: The task is running.'."\n" ."\n" .'- SUCCESSED: The task is successful.'."\n" ."\n" .'- SUSPENDED: The task is paused.'."\n" ."\n" .'- FAILED: The task failed.'."\n" ."\n" .'- CANCELED: The task is canceled.', 'type' => 'string', 'example' => 'RUNNING', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error details.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve Custom Broadcast Job Result ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomHotTopicBroadcastJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetCustomSourceTopicAnalysisTask' => [ 'summary' => 'Retrieves the results of a topic analysis task for a custom data source.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. It is the AgentKey.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'required' => true, 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The data returned.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'Status' => ['title' => '', 'description' => 'The status of the task. Valid values: \\`PENDING\\`, \\`RUNNING\\`, \\`SUCCESSED\\`, \\`FAILED\\`, and \\`CANCELED\\`.', 'type' => 'string', 'example' => 'SUCCESSED'], 'ParsedNewsSize' => ['title' => '', 'description' => 'The number of news articles after the file is parsed.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'ClusterCount' => ['title' => '', 'description' => 'The number of documents after clustering.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'MaxClusteredTopicNewsSize' => ['description' => 'The maximum number of news articles in a cluster after aggregation.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], 'ClusterResults' => [ 'description' => 'A list of news aggregation results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An aggregation result object.', 'title' => '', 'type' => 'object', 'properties' => [ 'ClusterNews' => [ 'description' => 'A list of aggregated news articles. The body text is not included.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A news object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'The title of the news article.', 'type' => 'string', 'example' => '新闻标题'."\n" ."\n"], 'Url' => ['title' => '', 'description' => 'The URL of the news article.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.html'], ], 'example' => '', ], 'example' => '', ], 'Topic' => ['title' => '', 'description' => 'The name of the aggregated topic.', 'type' => 'string', 'example' => '话题名称'], ], 'example' => '', ], 'example' => '', ], 'usages' => [ 'description' => 'The token usage. The possible billable items are:'."\n" .'quanmiaoMax, quanmiaoPlus', 'additionalProperties' => ['title' => '', 'description' => 'The number of tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], 'title' => '', 'type' => 'object', 'example' => '', ], 'rt' => ['title' => '', 'description' => 'The total runtime in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], ], 'example' => '', ], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Retrieve Custom Source Topic Analysis Job Result ', 'changeSet' => [ ['createdAt' => '2025-06-26T12:18:54.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomSourceTopicAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetCustomText' => [ 'summary' => 'Retrieve custom text.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Workspace unique identifier: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '63'], ], [ 'name' => 'CommodityCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Product code', 'type' => 'string', 'example' => '商品code', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'example' => '内容'], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '创建时间'], 'CreateUser' => ['title' => '', 'description' => 'Created by', 'type' => 'string', 'example' => '创建用户'], 'Id' => ['title' => '', 'description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '34'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '标题'], 'UpdateTime' => ['title' => '', 'description' => 'Update time', 'type' => 'string', 'example' => '修改时间'], 'UpdateUser' => ['title' => '', 'description' => 'Update user', 'type' => 'string', 'example' => '修改用户'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve custom text ', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetCustomTopicSelectionPerspectiveAnalysisTask' => [ 'summary' => 'Retrieve the result of a custom topic selection perspective analysis task.', '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' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique ID of the task.'."\n" ."\n" .'> The system generates a TaskId by default. If you specify the same TaskId for multiple tasks, those tasks belong to the same conversation group.', 'type' => 'string', 'required' => true, 'example' => '0dbf1055f8a2475d99904c3b76a0ffba'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'CustomViewPointsResult' => [ 'description' => 'Result of the custom topic selection analysis task', 'title' => '', 'type' => 'object', 'properties' => [ 'Attitudes' => [ 'description' => 'List of custom viewpoints. By default, the system generates one viewpoint based on the prompt input.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Attitude' => ['title' => '', 'description' => 'Current viewpoint', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['title' => '', 'description' => 'Viewpoint type', 'type' => 'string', 'example' => '观点类型'], 'Ratio' => ['title' => '', 'description' => 'Proportion of the current viewpoint', 'type' => 'string', 'example' => '当前观点占比'], 'ViewPoints' => [ 'description' => 'List of topic selection perspectives', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'Outline', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'Outline', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'Outline summary', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['title' => '', 'description' => 'Generated perspective', 'type' => 'string', 'example' => '视角'], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Topic' => ['title' => '', 'description' => 'Hot topic event', 'type' => 'string', 'example' => '热点主题事件'], ], 'example' => '', ], 'ErrorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误信息'], 'Status' => [ 'title' => '', 'description' => 'Task status (PENDING: pending, RUNNING: running, SUCCESSED: succeeded, SUSPENDED: suspended, FAILED: failed, CANCELED: canceled)', 'type' => 'string', 'example' => 'FAILED', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain Custom Viewpoints Analysis Job Result ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetDataSourceOrderConfig' => [ 'summary' => 'Retrieves configuration information for write data sources and general search data sources.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'd9a1f6146a37446495d9985c2e7b267e_p_outbound_public'], ], [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Configuration type. Possible values:'."\n" ."\n" .'- miaobi'."\n" ."\n" .'- miaosou', 'type' => 'string', 'required' => true, 'enum' => ['miaobi', 'miaosou'], 'example' => 'miaobi', ], ], [ 'name' => 'GenerateTechnology', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'When productCode=miaosou, this corresponds to Miaosou: generation technology. Possible values:'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- copilotPrecise'."\n" ."\n" .'- copilotReference', 'type' => 'string', 'required' => false, 'example' => 'copilotPrecise'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'UserConfigDataSourceList' => [ 'description' => 'List of user-configured data source weights', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Code description', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'Name' => ['title' => '', 'description' => 'Display name', 'type' => 'string', 'example' => '夸克通用搜索'], 'Number' => ['title' => '', 'description' => 'Quantity', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'Type' => ['title' => '', 'description' => 'Type', 'type' => 'string', 'example' => 'SystemSearch'], 'Enable' => ['title' => '', 'description' => 'Is enabled', 'type' => 'boolean', 'example' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalDocSize' => ['title' => '', 'description' => 'Maximum total document count', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => '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\\": false\\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' => 'Obtain data source configuration weight data', 'changeSet' => [ ['createdAt' => '2025-05-08T10:52:59.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-07T08:34:56.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-05-07T06:29:23.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-03T06:08:38.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetDataSourceOrderConfig'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDataSourceOrderConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetDataset' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the dataset. The name must be globally unique.', 'type' => 'string', 'example' => 'businessDataset', 'maxLength' => 30, 'minLength' => 3, 'required' => false], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the dataset. You must specify either this parameter or \\`DatasetName\\`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'DatasetId' => ['title' => '', 'description' => 'The ID of the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'CreateUser' => ['title' => '', 'description' => 'The user who created the dataset.', 'type' => 'string', 'example' => 'xxx'], 'CreateTime' => ['title' => '', 'description' => 'The time when the dataset was created.', 'type' => 'string', 'example' => '2024-11-12 21:46:24'], 'DatasetType' => ['title' => '', 'description' => 'The type of the dataset.', 'type' => 'string', 'example' => 'CustomSemanticSearch'], 'DatasetName' => ['title' => '', 'description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'xxx'], 'DatasetConfig' => [ 'description' => 'The search configuration of the dataset.', 'type' => 'object', 'properties' => [ 'SearchSourceConfigs' => [ 'description' => 'Third-party search: API definition.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Third-party search: API definition.', 'type' => 'object', 'properties' => [ 'DemoQuery' => ['title' => '', 'description' => 'A sample query keyword. This keyword is used to test whether the search source is available.', 'type' => 'string', 'example' => '可以搜索到的关键词，用来验证是否可用'], 'Size' => ['title' => '', 'description' => 'The default number of data entries for requests and responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'SearchSourceRequestConfig' => [ 'description' => 'The API request configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The API URL.', 'type' => 'string', 'example' => 'api地址'], 'Method' => ['title' => '', 'description' => 'The request method.', 'type' => 'string', 'example' => '请求方式'], 'ConnectTimeout' => ['title' => '', 'description' => 'The connection timeout period.', 'type' => 'integer', 'format' => 'int32', 'example' => '30'], 'SocketTimeout' => ['title' => '', 'description' => 'The read timeout period.', 'type' => 'integer', 'format' => 'int32', 'example' => '78'], 'Headers' => [ 'description' => 'The HTTP request headers.', 'type' => 'array', 'items' => [ 'description' => 'The HTTP request headers.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the parameter.', 'type' => 'string', 'example' => '参数名称'], 'ValueType' => ['title' => '', 'description' => 'The data type of the parameter value. Default value: string.', 'type' => 'string', 'example' => '参数值数据类型：默认string'], 'ValueFormat' => ['title' => '', 'description' => 'This parameter is valid only when \\`ValueType\\` is set to \\`time\\`.', 'type' => 'string', 'example' => 'valueType = time 时有效'], 'Value' => ['title' => '', 'description' => 'The value of the parameter.', 'type' => 'string', 'example' => '参数值'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'The request path parameters.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The request path parameters.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The name of the parameter.', 'type' => 'string', 'example' => '参数名称'], 'ValueType' => ['title' => '', 'description' => 'The data type of the parameter value. Default value: string.', 'type' => 'string', 'example' => '参数值数据类型：默认string'], 'ValueFormat' => ['title' => '', 'description' => 'This parameter is valid only when \\`ValueType\\` is set to \\`time\\`.', 'type' => 'string', 'example' => 'valueType = time 时有效'], 'Value' => ['title' => '', 'description' => 'The value of the parameter.', 'type' => 'string', 'example' => '参数值'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'PathParamsEnable' => ['title' => '', 'description' => 'Specifies whether to enable path parameters.', 'type' => 'boolean', 'example' => 'true'], 'Body' => ['title' => '', 'description' => 'The request body.', 'type' => 'string', 'example' => '请求body'], ], 'example' => '', ], 'SearchSourceResponseConfig' => [ 'description' => 'The API response configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'JqNodes' => [ 'description' => 'The node configurations.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The child node configurations.', 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the node.', 'type' => 'string', 'example' => '节点key'], 'Type' => ['title' => '', 'description' => 'The data type of the node. Valid values: string, number, list, object, and base.', 'type' => 'string', 'example' => '节点数据类型：string number list object base'], 'Path' => ['title' => '', 'description' => 'The path of the node.', 'type' => 'string', 'example' => '节点路径'], 'JqNodes' => [ 'description' => 'The child node configurations.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The child node configurations.', 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the node.', 'type' => 'string', 'example' => 'title'], 'Type' => ['title' => '', 'description' => 'The data type of the node. Valid values: string, number, list, object, and base.', 'type' => 'string', 'example' => 'string'], 'Path' => ['title' => '', 'description' => 'The path of the node.', 'type' => 'string', 'example' => '.title'], 'JqNodes' => [ 'description' => 'The child node configurations.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The child node configurations.', 'title' => '', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The key of the node.', 'type' => 'string', 'example' => 'title'], 'Type' => ['title' => '', 'description' => 'The data type of the node. Valid values: string, number, list, object, and base.', 'type' => 'string', 'example' => 'string'], 'Path' => ['title' => '', 'description' => 'The path of the node.', 'type' => 'string', 'example' => '.title'], ], 'example' => '', ], 'example' => '', ], ], 'example' => 'xx', ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SearchSourceConfig' => [ 'description' => 'The configuration items for the dataset.', 'type' => 'object', 'properties' => [ 'TagSearchEnable' => ['description' => 'Specifies whether to include tags in the search. Default value: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'TagGenerateEnable' => ['description' => 'Specifies whether to include tags in the generation. Default value: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'MetadataKeyValueSearchEnable' => ['description' => 'Specifies whether to include the key-value pairs of metadata in the search. Default value: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'MetadataKeyValueGenerateEnable' => ['description' => 'Specifies whether to include the key-value pairs of metadata in the generation. Default value: true.', 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'DatasetDescription' => ['title' => '', 'description' => 'The display name of the dataset.', 'type' => 'string', 'example' => 'xxx'], 'SearchDatasetEnable' => ['title' => '', 'description' => 'The switch that enables or disables search for the dataset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'DocumentHandleConfig' => [ 'description' => 'The document processing configuration.', 'type' => 'object', 'properties' => [ 'DisableHandleMultimodalMedia' => ['title' => '', 'description' => 'Specifies whether to disable the processing logic for multimedia files. Default value: false.', 'type' => 'boolean', 'example' => 'true'], ], 'title' => '', 'example' => '', ], 'AccessLevel' => ['type' => 'string', 'example' => 'private', 'description' => '', 'title' => ''], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Data Source - Details', 'summary' => 'Data source management details.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetDatasetDocument' => [ 'summary' => 'Retrieve the data source document.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace. [Get the workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the dataset.', 'type' => 'string', 'example' => '数据集名称', 'required' => false], ], [ 'name' => 'DocUuid', 'in' => 'formData', 'schema' => ['description' => 'Internal unique identifier of the document.', 'type' => 'string', 'example' => 'xxx', 'required' => false, 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'User-defined unique ID of the document.', 'type' => 'string', 'example' => 'xxx', 'required' => false, 'title' => ''], ], [ 'name' => 'IncludeFields', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of fields to include in the response.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Field names to include. For example, metadata.', 'type' => 'string', 'required' => false, 'example' => 'metadata'], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'Unique ID of the document in the document system.', 'type' => 'string', 'example' => 'xxx'], 'Url' => ['description' => 'URL of the article.', 'type' => 'string', 'example' => 'https://www.aliyun.com', 'title' => ''], 'Content' => ['description' => 'Content of the article.', 'type' => 'string', 'example' => '文章内容', 'title' => ''], 'Summary' => ['title' => '', 'description' => 'Summary of the article.', 'type' => 'string', 'example' => '文章摘要'], 'Title' => ['description' => 'Title of the document.', 'type' => 'string', 'example' => '文档标题'."\n" ."\n", 'title' => ''], 'PubTime' => ['description' => 'Publication time in yyyy-MM-dd HH:mm:ss format.', 'type' => 'string', 'example' => '2024-05-14 08:54:33', 'title' => ''], 'SourceFrom' => ['title' => '', 'description' => 'Source of the document.', 'type' => 'string', 'example' => '来源'], 'DisableHandleMultimodalMedia' => ['title' => '', 'description' => 'Whether this record is indexed in the multimodal index library.', 'type' => 'boolean', 'example' => 'true'], 'DocId' => ['title' => '', 'description' => 'User-side unique ID of the document.', 'type' => 'string', 'example' => 'xxx'], 'Metadata' => [ 'description' => 'Dictionary information.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Metadata for the document dimension.', 'type' => 'string', 'example' => 'xx'], 'VideoShots' => [ 'description' => 'Video sharding information.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Video sharding information.', 'title' => '', 'type' => 'object', 'properties' => [ 'StartTime' => ['title' => '', 'description' => 'Start time of the video shard in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], 'EndTime' => ['title' => '', 'description' => 'End time of the video shard in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'], 'Text' => ['title' => '', 'description' => 'Content of the video shard.', 'type' => 'string', 'example' => 'xxx'], ], 'example' => '', ], 'example' => '', ], 'AsrSentences' => [ 'description' => 'ASR results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'ASR result.', 'title' => '', 'type' => 'object', 'properties' => [ 'StartTime' => ['title' => '', 'description' => 'Start time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], 'EndTime' => ['title' => '', 'description' => 'End time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000'], 'Text' => ['title' => '', 'description' => 'ASR text content.', 'type' => 'string', 'example' => 'xxx'], ], 'example' => '', ], 'example' => '', ], 'KeyValues' => [ 'description' => 'Key-value structure metadata', 'type' => 'array', 'items' => [ 'description' => 'Key-value structure metadata', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'Parameter Name ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Value' => ['description' => 'Parameter value ', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'DocType' => ['title' => '', 'description' => 'Document type. For example, video or image.', 'type' => 'string', 'example' => 'video'], 'Status' => ['title' => '', 'description' => 'Document status. 100 means success. 0 means failure. 1 means indexing or queued.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'CategoryUuid' => ['description' => 'Category UUID ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tags. ', 'type' => 'array', 'items' => ['description' => 'Tags. ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. true means success. false means failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Data Source - Retrieve Document Details ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetDeepWriteTask' => [ 'summary' => 'Queries deep writing tasks. You can use it to check the running status of a specific task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-odl2p61i4vfbph4g'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'required' => false, 'example' => '6d3c0bc9-7561-41a4-be4c-d906abdb40a9'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP error code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'Task response object', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => 'a2267372-6042-46a4-aab0-1670dfc38c94'], 'Input' => ['title' => '', 'description' => 'User\'s question', 'type' => 'string', 'example' => '北京2025年新能源汽车发展趋势'], 'Status' => [ 'title' => '', 'description' => 'Task status', 'enumValueTitles' => ['in_progress' => 'running', 'queued' => 'queued', 'cancelled' => 'cancelled', 'completed' => 'completed', 'failed' => 'failed'], 'type' => 'string', 'example' => 'queued', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Query depth writing job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDeepWriteTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetDeepWriteTaskResult' => [ 'summary' => 'Queries the result of a deep writing task. If the task is not complete, the operation returns its current status—such as queued, running, failed, or canceled. If the task is complete, the operation returns a URL that points to a compressed package of the task output that you can download.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-1setzb9xb8m11vrc'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'required' => false, 'example' => 'xbabac91-fdad-44d6-95ce-******'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], 'Code' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The task response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => 'f8707efa-c30e-407f-a611-50871aa68952'], 'ArtifactUrl' => ['title' => '', 'description' => 'The download URL for the task result.', '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'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": false,\\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' => 'Query the result of a depth writing Job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDeepWriteTaskResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetDocClusterTask' => [ 'summary' => 'Retrieves the result of a content aggregation task.', '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' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> This parameter is optional. The system automatically generates a task ID. If subsequent tasks use the same task ID, they are considered part of the same conversation group.', 'type' => 'string', 'required' => true, 'example' => '93771c8e1142467fb1aedf1763feba1e'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'Status' => [ 'title' => '', 'description' => 'The status of the task. Valid values: PENDING (to be executed), RUNNING (executing), SUCCESSED (successful), SUSPENDED (paused), FAILED (failed), and CANCELED (canceled).', 'type' => 'string', 'example' => 'PENDING', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], ], 'Topics' => [ 'description' => 'A list of clustering topics.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A hot spot event object.', 'type' => 'object', 'properties' => [ 'DocIds' => [ 'description' => 'A list of document IDs for the clustering topic.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The document ID.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'example' => '', ], 'Summary' => ['title' => '', 'description' => 'The summary of the clustering topic.', 'type' => 'string', 'example' => '聚类主题摘要'], 'Title' => ['title' => '', 'description' => 'The name of the clustering topic.', 'type' => 'string', 'example' => '聚类主题名'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\`: The request was successful. \\`false\\`: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Obtain content aggregation job result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDocClusterTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetDocInfo' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the workspace in Alibaba Cloud Model Studio. For instructions on how to obtain a workspace ID, see [Obtain a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'The category where the document is stored.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The schema of the response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The internal error code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'DocName' => ['description' => 'The document name.', 'type' => 'string', 'example' => '電視廣播2020年報', 'title' => ''], 'DocType' => ['description' => 'The document type.', 'type' => 'string', 'example' => 'pdf', 'title' => ''], 'FileUrl' => ['description' => 'The URL of the document.', 'type' => 'string', 'example' => 'http://xxx/xxx.pdf', 'title' => ''], 'Status' => ['description' => 'The task status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1和0，当状态为1时 表示获取文档成功，用户可进行生成文档摘要、生脑图等操作', 'title' => ''], 'StatusMessage' => ['description' => 'The status message.', 'type' => 'string', 'example' => '导入成功', 'title' => ''], 'VideoContents' => [ 'description' => 'Text transcripts from the video\'s audio.', 'type' => 'array', 'items' => ['description' => 'A text transcript from the video\'s audio.', 'type' => 'string', 'example' => '文本内容', 'title' => ''], 'title' => '', 'example' => '', ], 'CategoryId' => ['description' => 'The category where the document is stored.', 'type' => 'string', 'example' => 'default', 'title' => ''], 'PageInfo' => [ 'type' => 'object', 'properties' => [ 'Width' => ['type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => '', 'title' => ''], 'Height' => ['type' => 'integer', 'format' => 'int32', 'example' => '200', 'description' => '', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Retrieve document information', 'summary' => 'Retrieves information about a document.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDocInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'GetEnterpriseVocAnalysisTask' => [ 'summary' => 'Retrieves the result of an enterprise Voice of the Customer (VOC) analysis task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> You do not need to specify this parameter. The system automatically generates a TaskId. If you specify the same TaskId for subsequent tasks, the tasks are considered part of the same conversation group.', 'type' => 'string', 'required' => true, 'example' => 'xxx'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The result of the enterprise VOC analysis.', 'title' => '', 'type' => 'object', 'properties' => [ 'StatisticsOverview' => [ 'description' => 'The statistics overview.', 'title' => '', 'type' => 'object', 'properties' => [ 'Count' => ['title' => '', 'description' => 'The total number of analyzed data entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'TagDimensionStatistics' => [ 'description' => 'The statistics of content tags.', 'title' => '', 'type' => 'object', 'properties' => [ 'TagValueCountStatistic' => [ 'description' => 'The statistics of tag value counts.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TagName' => ['title' => '', 'description' => 'The tag name.', 'type' => 'string', 'example' => 'xxx'], 'TagTaskType' => ['title' => '', 'description' => 'The type of the tag mining task. Valid values: \\`singleTagValue\\` (single tag), \\`multiTagValues\\` (multiple tags), and \\`summaryAndOverview\\` (summary and overview).', 'type' => 'string', 'example' => 'multiTagValues'], 'ValueCount' => ['title' => '', 'description' => 'The number of tag values.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'FilterDimensionStatistics' => [ 'description' => 'The statistics of filter tags.', 'title' => '', 'type' => 'object', 'properties' => [ 'TagValueCountStatistic' => [ 'description' => 'The statistics of tag value counts.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'TagName' => ['title' => '', 'description' => 'The tag name.', 'type' => 'string', 'example' => 'xxx'], 'TagTaskType' => ['title' => '', 'description' => 'The type of the tag mining task. Valid values: \\`singleTagValue\\` (single tag), \\`multiTagValues\\` (multiple tags), and \\`summaryAndOverview\\` (summary and overview).', 'type' => 'string', 'example' => 'multiTagValues'], 'ValueCount' => ['title' => '', 'description' => 'The number of tag values.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'Usage' => [ 'description' => 'The usage statistics.', 'title' => '', 'type' => 'object', 'properties' => [ 'OutputTokens' => ['title' => '', 'description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'InputTokens' => ['title' => '', 'description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], 'Status' => ['title' => '', 'description' => 'The status of the task. Valid values: \\`PENDING\\` (pending), \\`RUNNING\\` (running), \\`SUCCESSED\\` (successful), \\`FAILED\\` (failed), and \\`CANCELED\\` (canceled).', 'type' => 'string', 'example' => 'SUCCESSED'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'error'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve Enterprise VOC Mining Job Result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetEnterpriseVocAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetFactAuditUrl' => [ 'summary' => 'Retrieves the source URL that is currently used for factuality audit.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. Get the [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Whether this request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'minItems' => 0, 'maxItems' => 10, 'description' => 'List of source URLs currently used for factuality audit. If the list is empty, the retrieval source is the entire network. If URLs are present, information is retrieved only from the configured URLs. To delete unnecessary source URLs, use the URLs from the response parameter as input for the DeleteFactAuditUrl API.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Returned data content.', 'type' => 'string', 'example' => 'aliyun.com', 'title' => ''], 'required' => true, 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Retrieve Factuality Review URLs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:GetFactAuditUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetFileContentLength' => [ 'summary' => 'MiaoRead calculates the word count for a document.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of an Alibaba Cloud Model Studio workspace. Get your [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'formData', 'schema' => ['description' => 'Document name', 'type' => 'string', 'required' => false, 'example' => 'test.pdf', 'title' => ''], ], [ 'name' => 'FileUrl', 'in' => 'formData', 'schema' => ['description' => 'File URL', 'type' => 'string', 'required' => false, 'example' => 'https://xxx/test.pdf', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Unique request identifier', 'type' => 'string', 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87', 'title' => ''], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'WordNum' => ['description' => 'File length', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the operation succeeded. true means success. false means failure.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Get Document Length', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetFileContentLength', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetGeneralConfig' => [ 'summary' => 'Queries general configurations.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Model Studio workspace. For more information, see [Get workspaceId]().', 'type' => 'string', 'required' => true, 'example' => 'llm-'], ], [ 'name' => 'ConfigKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the configuration.', 'type' => 'string', 'required' => true, 'example' => 'xx'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response result.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: true (successful), false (failed).', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'The result.', 'title' => '', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'The unique identifier of the configuration.', 'type' => 'string', 'example' => 'xx'], 'ConfigValue' => ['title' => '', 'description' => 'The configuration value.', 'type' => 'string', 'example' => 'xx'], 'ConfigValueType' => ['title' => '', 'description' => 'The configuration value type.', 'type' => 'string', 'example' => 'xx'], 'ConfigDesc' => ['title' => '', 'description' => 'The configuration description.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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 \\"Data\\": {\\n \\"ConfigKey\\": \\"xx\\",\\n \\"ConfigValue\\": \\"xx\\",\\n \\"ConfigValueType\\": \\"xx\\",\\n \\"ConfigDesc\\": \\"xx\\"\\n }\\n}","type":"json"}]', 'title' => 'General Configuration - Details', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetGeneratedContent' => [ 'summary' => 'Get generated content. Queries the history of articles generated in MiaoBi.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Workspace ID: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Document ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Rich text content', 'type' => 'string', 'example' => '杭州亚运会'], 'ContentDomain' => ['title' => '', 'description' => 'Content generation domain. Valid values: media (news) and government (government services)', 'type' => 'string', 'example' => 'media'], 'ContentText' => ['title' => '', 'description' => 'Plain text content', 'type' => 'string', 'example' => '杭州亚运会'], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2024-01-04 11:46:07'], 'CreateUser' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '"1"'], 'DeviceId' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => 'xxx'], 'Id' => ['title' => '', 'description' => 'Document ID', 'type' => 'integer', 'format' => 'int64', 'example' => '86'], 'KeywordList' => [ 'description' => 'Keywords', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Keyword', 'type' => 'string', 'example' => '观点', 'title' => ''], 'example' => '', ], 'Keywords' => ['title' => '', 'description' => 'Keywords (string format)', 'type' => 'string', 'example' => '[\\"教师\\",\\"乡村\\"]'], 'Prompt' => ['title' => '', 'description' => 'Last prompt used to generate this content', 'type' => 'string', 'example' => '创作xxx文章'], 'TaskId' => ['title' => '', 'description' => 'Session task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '杭州亚运会'], 'UpdateTime' => ['title' => '', 'description' => 'Update time', 'type' => 'string', 'example' => '2024-01-04 11:46:07'], 'UpdateUser' => ['title' => '', 'description' => 'Updater', 'type' => 'string', 'example' => '"1"'], 'Uuid' => ['title' => '', 'description' => 'UUID for traceability', 'type' => 'string', 'example' => '0961a514-2e26-4aa6-b22b-f592d145fe47'], 'IgnoreContentAuditWords' => ['title' => '', 'description' => 'List of words to ignore during content audit (JSON string)', 'type' => 'string', 'example' => '"[{}]"'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded. true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve document ', 'changeSet' => [ ['createdAt' => '2025-05-23T01:59:01.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetGeneratedContent'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetHotTopicBroadcast' => [ 'summary' => 'Query news broadcast orders.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'UUID of the Alibaba Cloud Model Studio workspace: obtain the [Workspace ID](~~2587495~~)', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'HotTopicVersion', 'in' => 'formData', 'schema' => ['description' => 'hot spot Version ', 'title' => '', 'type' => 'string', 'example' => '2024-10-11_13', 'required' => false], ], [ 'name' => 'Topics', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'topic Filter', 'title' => '', 'type' => 'array', 'items' => ['description' => 'hot spot subject', 'type' => 'string', 'example' => '["主题1","主题2"]', 'required' => false, 'title' => ''], 'required' => false, 'example' => '["主题1","主题2"]', ], ], [ 'name' => 'CalcTotalToken', 'in' => 'formData', 'schema' => ['description' => 'Whether to compute the total token count', 'title' => '', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'Category', 'in' => 'formData', 'schema' => ['description' => 'categorization Filter', 'title' => '', 'type' => 'string', 'example' => '分类筛选', 'required' => false], ], [ 'name' => 'StepForNewsBroadcastContentConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Hot Spot News Broadcast Content Configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'Categories' => [ 'description' => 'List of selected channels', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Channel', 'type' => 'string', 'example' => '["科技","经济","时政","娱乐"]', 'required' => false, 'title' => ''], 'required' => false, 'example' => '["科技","经济","时政","娱乐"]', ], 'CustomHotValueWeights' => [ 'deprecated' => true, 'description' => 'Custom hot spot weight', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Custom weight', 'type' => 'object', 'properties' => [ 'Dimension' => ['description' => 'Dimension key', 'title' => '', 'type' => 'string', 'example' => 'views', 'required' => false], 'Weight' => ['description' => 'weight ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'TopicCount' => ['description' => 'topic Quantity ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'StepForCustomSummaryStyleConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Custom output style configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'SummaryImageCount' => ['description' => 'Summary – number of images', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '90', 'required' => false], 'SummaryModel' => ['description' => 'Summary model', 'title' => '', 'type' => 'string', 'required' => false, 'example' => '摘要模型'], 'SummaryPrompt' => ['description' => 'Summary - Custom Prompt', 'title' => '', 'type' => 'string', 'example' => '摘要-自定义Prompt', 'required' => false], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['description' => 'Page size', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'required' => false], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['description' => 'Current page number ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'Locations', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of Regions for news retrieval (keyword filtering)', 'title' => '', 'type' => 'array', 'items' => ['description' => 'News Region retrieval (keyword filtering)', 'type' => 'string', 'required' => false, 'example' => '重庆', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'LocationQuery', 'in' => 'formData', 'schema' => ['description' => 'Full-text index for hot spot Regions (when this parameter is present, current does not take effect)', 'title' => '', 'type' => 'string', 'required' => false, 'example' => '重庆 成都 浙江 杭州'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['description' => 'Full-text index (full-text retrieval for title, hot spot summary, and Region) (when this parameter is present, current does not take effect)', 'title' => '', 'type' => 'string', 'required' => false, 'example' => '重庆新闻'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'status code', 'title' => '', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business Data', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'List of hot spot bulletins ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Hot spot information ', 'type' => 'object', 'properties' => [ 'Category' => ['description' => 'Hot topic category ', 'title' => '', 'type' => 'string', 'example' => '热点话题分类'], 'CreateTime' => ['description' => 'Creation Time ', 'title' => '', 'type' => 'string', 'example' => '创建时间'], 'CustomHotValue' => ['description' => 'Custom hotness value', 'title' => '', 'type' => 'number', 'format' => 'double', 'example' => '34.7905341705522'], 'CustomTextSummary' => ['description' => 'Custom text summarization of the hot spot topic ', 'title' => '', 'type' => 'string', 'example' => '自定义热点话题文本摘要'], 'HotTopic' => ['description' => 'Name of the hot spot topic ', 'title' => '', 'type' => 'string', 'example' => '热点话题名称'], 'HotTopicVersion' => ['description' => 'hot spot topic summary Version', 'title' => '', 'type' => 'string', 'example' => '热点话题摘要版本'], 'HotValue' => ['description' => 'Hotness value ', 'title' => '', 'type' => 'number', 'format' => 'double', 'example' => '1.4120480606282884'], 'Id' => ['description' => 'hot spot topic ID', 'title' => '', 'type' => 'string', 'example' => '热点话题ID'], 'Images' => [ 'description' => 'List of hot spot topic images ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Image object ', 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'URL link ', 'type' => 'string', 'example' => 'http://www.example.com/a.png', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'InputToken' => ['description' => 'Input Token', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '29'], 'News' => [ 'description' => 'Article List', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'News object', 'type' => 'object', 'properties' => [ 'AnalysisCategory' => ['description' => 'Model categorization result', 'type' => 'string', 'example' => '科技', 'title' => ''], 'AnalysisTopic' => ['description' => 'aggregated hot spot name', 'title' => '', 'type' => 'string', 'example' => '聚合后热点名称'], 'Author' => ['description' => 'Author', 'type' => 'string', 'example' => '作者', 'title' => ''], 'Category' => [ 'description' => 'Categorization', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Categorization', 'type' => 'string', 'example' => '科技', 'title' => ''], 'example' => '', ], 'Comments' => [ 'description' => 'News content', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Object', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'Content', 'title' => '', 'type' => 'string', 'example' => '内容'], 'Username' => ['description' => 'Username', 'title' => '', 'type' => 'string', 'example' => '用户名'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Content' => ['description' => 'News content', 'type' => 'string', 'example' => '新闻内容'."\n" ."\n", 'title' => ''], 'CreateTime' => ['description' => 'Ingestion time', 'type' => 'string', 'example' => '2024-06-13 08:45:05', 'title' => ''], 'Domain' => ['description' => 'Source ', 'type' => 'string', 'example' => '夸克', 'title' => ''], 'Dt' => ['description' => 'Date of entry', 'type' => 'string', 'example' => '2024111110', 'title' => ''], 'HotTopic' => ['description' => 'original hot spot name', 'title' => '', 'type' => 'string', 'example' => '原始热点名称'], 'ImgList' => [ 'description' => 'Image list', 'type' => 'array', 'items' => ['description' => 'Image URL', 'type' => 'string', 'example' => 'http://www.example.com/a.png', 'title' => ''], 'title' => '', 'example' => '', ], 'Logo' => ['description' => 'logo', 'type' => 'string', 'example' => 'https://www.example.com/a.png', 'title' => ''], 'PubTime' => ['description' => 'Published At', 'type' => 'string', 'example' => '2024-10-10 12:12:00', 'title' => ''], 'Summary' => ['description' => 'Summary', 'title' => '', 'type' => 'string', 'example' => '摘要'], 'Title' => ['description' => 'title', 'type' => 'string', 'example' => '标题', 'title' => ''], 'Url' => ['description' => 'news URL', 'type' => 'string', 'example' => 'http://www.example.com/a.png', 'title' => ''], 'Uuid' => ['description' => 'Primary key ID', 'title' => '', 'type' => 'string', 'example' => '主键ID'], 'Website' => ['description' => 'website', 'title' => '', 'type' => 'string', 'example' => '网站'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'OutputToken' => ['description' => 'Output Token', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '22'], 'Summary' => [ 'description' => 'Structured summary of hot spot topics ', 'title' => '', 'type' => 'object', 'properties' => [ 'InputToken' => ['description' => 'Number of input tokens used to generate this summary ', 'type' => 'integer', 'format' => 'int32', 'example' => '17', 'title' => ''], 'OutputToken' => ['description' => 'Number of output tokens used to generate this summary ', 'type' => 'integer', 'format' => 'int32', 'example' => '41', 'title' => ''], 'Summaries' => [ 'description' => 'List of structured summaries ', 'type' => 'array', 'items' => [ 'description' => 'Structured summary ', 'type' => 'object', 'properties' => [ 'Summary' => ['description' => 'Summary ', 'title' => '', 'type' => 'string', 'example' => '摘要'], 'Title' => ['description' => 'title', 'title' => '', 'type' => 'string', 'example' => '标题'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'TextSummary' => ['description' => 'Text summary of the hot topic ', 'title' => '', 'type' => 'string', 'example' => '热点话题文本摘要'], 'Locations' => [ 'description' => 'List of Regions associated with the hot spot ', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Region information of the hot spot ', 'title' => '', 'type' => 'string', 'example' => '成都'], 'example' => '', ], 'Url' => ['description' => 'Hot list URL', 'title' => '', 'type' => 'string', 'example' => 'http://www.example.com/a.html'], 'PubTime' => ['description' => 'Published At', 'title' => '', 'type' => 'string', 'example' => '2025-08-01 12:00:00'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalCount' => ['description' => 'Total count', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'TotalTokenInfo' => [ 'description' => 'Estimated total number of tokens required for generation', 'title' => '', 'type' => 'object', 'properties' => [ 'HotTopicCount' => ['description' => 'Total number of hot spots', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'InputTokens' => ['description' => 'Estimated number of input tokens', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'OutputTokens' => ['description' => 'Estimated number of output tokens ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'WordCount' => ['description' => 'Estimated total word count', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['description' => 'Fault description', 'title' => '', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['description' => 'Request UUID', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'is successful: true indicates Succeeded, false indicates failed', 'title' => '', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'query full broadcast list (hot list)', 'changeSet' => [ ['createdAt' => '2025-06-09T11:39:29.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-31T12:47:20.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-31T05:13:53.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T13:21:02.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetHotTopicBroadcast', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'GetInterveneGlobalReply' => [ 'summary' => 'Retrieve the global intervention reply.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identity of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'ReplyMessagList' => [ 'description' => 'Reply message list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Reply content', 'type' => 'string', 'example' => 'success'], 'ReplyType' => [ 'title' => '', 'description' => 'Reply type', 'enumValueTitles' => ['namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A input intervention)', 'namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A result intervention)', 'namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (writing result intervention)', 'namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (writing input intervention)'], 'type' => 'string', 'example' => 'namespace_qa_query', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain global intervention reply content', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneGlobalReply', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', 'flowControl' => [ 'flowControlList' => [], ], ], 'GetInterveneImportTaskInfo' => [ 'summary' => 'Gets information about an import task.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the task.'."\n" ."\n" .'> This parameter is optional. The system automatically generates a task ID if you do not specify this parameter. Tasks that have the same \\`TaskId\\` belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => '19162157'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'The status information of the task.', 'title' => '', 'type' => 'object', 'properties' => [ 'Msg' => ['title' => '', 'description' => 'The information about the task.', 'type' => 'string', 'example' => 'success'], 'Percentage' => ['title' => '', 'description' => 'The completion percentage.', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], 'Status' => [ 'title' => '', 'description' => 'The status of the task.', 'enumValueTitles' => ['3-超时' => '3: Timeout', '2-错误' => '2: Error', ' 1-进行中 ' => '1: In progress', '0-结束' => '0: Finished'], 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '41405255'], 'TaskName' => ['title' => '', 'description' => 'The name of the task.', 'type' => 'string', 'example' => 'ft-task-20190101m8rnK'], ], 'example' => '', ], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'Success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success, and a value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain the import job information for an intervention project', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneImportTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetInterveneRuleDetail' => [ 'summary' => 'Retrieves the details of an intervention rule.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm'], ], [ 'name' => 'RuleId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'InterveneRuleDetail' => [ 'description' => 'Structure of the rule details', 'title' => '', 'type' => 'object', 'properties' => [ 'AnswerConfig' => [ 'description' => 'Answer configuration', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AnswerType' => [ 'title' => '', 'description' => 'Answer type', 'enumValueTitles' => ['0-统一回复' => '0-Standard response', '1-定向回复 ' => '1-Direct Reply'], 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Message' => ['title' => '', 'description' => 'Answer content', 'type' => 'string', 'example' => '早上好'], 'Namespace' => [ 'title' => '', 'description' => 'Namespace', 'enumValueTitles' => [' namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (writing input intervention)', ' namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A pair result intervention)', 'namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A pair input intervention)', ' namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (writing result intervention)'], 'type' => 'string', 'example' => 'namespace_qa_query', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'EffectConfig' => [ 'description' => 'Activation configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'EffectType' => [ 'title' => '', 'description' => 'Activation type', 'enumValueTitles' => ['0-永久生效 ' => '0 - Permanent', '1-按时间生效' => '1\\. Time-based activation'], 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'EndTime' => ['title' => '', 'description' => 'End time', 'type' => 'string', 'example' => '2023-11-25 14:21:15'], 'StartTime' => ['title' => '', 'description' => 'Start time', 'type' => 'string', 'example' => '2023-11-25 14:21:15'], ], 'example' => '', ], 'InterveneType' => [ 'title' => '', 'description' => 'Intervention type', 'enumValueTitles' => ['3-关键词库干预项 ' => '3-Keyword Library Intervention Items', '0-相似问干预项目 ' => '0-similarity intervention project', ' 2-正则表达式干预项 ' => '2-Regular expression intervention items', '4-URL干预' => '4-URL Intervention', '1-关键词表达式干预项' => '1-Keyword expression intervention item'], 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'NamespaceList' => [ 'description' => 'Namespace list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Intervention dimension', 'enumValueTitles' => ['namespace_writing_image （智能配图）' => 'namespace\\_writing\\_image (AI-powered image generation)', 'namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A input intervention)', 'namespace_qa_article （问答参考）' => 'namespace\\_qa\\_article (Q\\&A reference)', 'namespace_writing_article （写作参考）' => 'namespace\\_writing\\_article (writing reference)', 'namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A result intervention)', 'namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (writing result intervention)', 'namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (writing input intervention)'], 'type' => 'string', 'example' => 'namespace_qa_query', 'title' => '', ], 'example' => '', ], 'RuleId' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100418'], 'RuleName' => ['title' => '', 'description' => 'Rule name', 'type' => 'string', 'example' => '规则001'], ], 'example' => '', ], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Obtain details of an intervention rule ', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneRuleDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetInterveneTemplateFileUrl' => [ 'summary' => 'Retrieves the download URL for the intervention import template.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileUrl' => ['title' => '', 'description' => 'The URL of the template file.', 'type' => 'string', 'example' => 'http://xxx/xxx.xls'], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain the URL of the intervention import template file', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneTemplateFileUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetMaterialById' => [ 'summary' => 'Retrieves detailed information about a material from the Material Library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'Primary key ID of the task', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '60', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '文档作者'], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2023-03-21 11:34:19'], 'CreateUser' => ['title' => '', 'description' => 'Creator user ID', 'type' => 'string', 'example' => '1'], 'DocKeywords' => [ 'description' => 'Document tags used for classification and other purposes. Separate multiple keywords with commas.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Keyword', 'type' => 'string', 'example' => '关键词', 'title' => ''], 'example' => '', ], 'DocType' => ['title' => '', 'description' => 'Document type, such as pdf, word, url, or image', 'type' => 'string', 'example' => 'pdf'], 'ExternalUrl' => ['title' => '', 'description' => 'URL uploaded by an external customer. Used only for record keeping.', 'type' => 'string', 'example' => 'https://www.example.com'."\n"], 'HtmlContent' => ['description' => 'Web page content', 'type' => 'string', 'example' => '网页内容', 'title' => ''], 'Id' => ['title' => '', 'description' => 'Primary key', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], 'PubTime' => ['title' => '', 'description' => 'Publication time', 'type' => 'string', 'example' => '2023-04-11 06:14:07'."\n"], 'PublicUrl' => ['title' => '', 'description' => 'Temporary public URL', 'type' => 'string', 'example' => 'https://www.example.com'."\n"], 'ShareAttr' => [ 'title' => '', 'description' => 'Sharing attribute stored as bit flags. The first bit indicates sharing within the workspace, the second bit indicates sharing within the tenant, and the third bit indicates system-wide sharing.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['0', '1'], ], 'SrcFrom' => ['title' => '', 'description' => 'Document source, such as user\\_upload, search, or viewpoint', 'type' => 'string', 'example' => 'user_upload'], 'Summary' => ['title' => '', 'description' => 'Document summary', 'type' => 'string', 'example' => '文档摘要'], 'TextContent' => ['title' => '', 'description' => 'Parsed text content. Empty for images.', 'type' => 'string', 'example' => '文本内容'], 'ThumbnailInBase64' => ['title' => '', 'description' => 'Base64-encoded thumbnail for image documents', 'type' => 'string', 'example' => 'Base64编码的缩略图'], 'Title' => ['title' => '', 'description' => 'Document title', 'type' => 'string', 'example' => '文档标题'], 'UpdateTime' => ['title' => '', 'description' => 'Modification time', 'type' => 'string', 'example' => '2022-04-08 19:33:01'], 'UpdateUser' => ['title' => '', 'description' => 'Modifier user ID', 'type' => 'string', 'example' => '1'], 'Url' => ['title' => '', 'description' => 'Internal document storage URL', 'type' => 'string', 'example' => 'https://www.example.com'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'false'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve Material', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetMaterialById'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetMaterialById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetPptArtifact' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-az2gglxxxx'], ], [ 'name' => 'PptArtifactId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the PPT artifact.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '5232136'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误消息', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The time when the resource was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-11-25 11:40:50'], 'Id' => ['description' => 'The unique ID of the artifact.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Title' => ['description' => 'The title.', 'type' => 'string', 'title' => '', 'example' => '内容标题'."\n" ."\n"], 'UpdateTime' => ['description' => 'The time when the artifact was last updated.', 'type' => 'string', 'title' => '', 'example' => '2024-11-25 11:40:50'], 'FileKey' => ['description' => 'The storage path of the file in the backend.', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx', 'title' => ''], 'FileAttr' => [ 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'xxx.pptx', 'title' => ''], 'Width' => ['description' => 'The width.', 'type' => 'integer', 'format' => 'int32', 'example' => '800', 'title' => ''], 'TmpUrl' => ['description' => 'The temporary access URL for the file. The URL expires in one hour.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.pptx', 'title' => ''], 'Height' => ['description' => 'The height.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], ], 'description' => 'The file properties.', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'The task response object.', 'example' => '', ], ], 'title' => '', 'description' => 'The response schema.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetPptArtifact', 'summary' => 'Queries information about a PPT artifact.', 'description' => 'Usage notes:'."\n" ."\n" .'- This API uses the HTTP Server-Sent Events (SSE) protocol.'."\n" ."\n" .'- The OpenAPI portal is not compatible with the SSE protocol and cannot be used for direct debugging. For examples of how to call the API using an SDK for Java or Python, see [PPT Generation Best practices](https://help.aliyun.com/zh/model-studio/ppt-generation-best-practices).'."\n" ."\n" .'- To obtain the latest version of the asynchronous Java SDK, [download it from the API portal](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' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetPptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetPptArtifactExportResult' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxx'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], [ 'name' => 'ExportTaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the export task.', 'type' => 'string', 'example' => '15aeb61b-cdeb-4b70-94d7-99518040647e', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'ExportFileLink' => [ 'description' => 'The links to the exported files.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A file link.', 'type' => 'string', 'example' => 'http://xxx.com/a.png', 'title' => ''], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query the result of a PPT export task ', 'summary' => 'Retrieves the result of a PPT export task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptArtifactExportResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetPptConfig' => [ 'summary' => 'Retrieves the configuration of a PPT component.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-az2gglkjauwnnhpq'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'AppKey' => ['title' => '', 'description' => 'AppKey', 'type' => 'string', 'example' => '333444766'], 'Code' => ['title' => '', 'description' => 'Code', 'type' => 'string', 'example' => 'r4wr5y6g'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Obtain PPT widget configuration ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetPptInfo' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'llm-2setzb9xb8mx6vss', 'title' => '', 'required' => false], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => false, 'example' => '1f178f22-ec52-467d-8489-eef4468x0240', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误消息', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'Data' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The ID of the task.', 'type' => 'string', 'example' => 'xxx-xxx-xx', 'title' => ''], 'Query' => ['description' => 'The query for the PPT task.', 'type' => 'string', 'example' => '关于班会主题的PPT', 'title' => ''], 'PptProcessId' => ['description' => 'The ID of the PPT process.', 'type' => 'string', 'example' => '11231232', 'title' => ''], 'PptArtifactId' => ['description' => 'The ID of the PPT artifact.', 'type' => 'string', 'example' => '5423431', 'title' => ''], 'PptArtifactCover' => ['description' => 'The URL of the cover image for the PPT artifact.', 'type' => 'string', 'example' => 'http://a.com/xxx.jpeg', 'title' => ''], 'ExportTaskId' => ['description' => 'The ID of the export task.', 'type' => 'string', 'example' => 'xxx-xxx-xx', 'title' => ''], 'ExportFileLink' => [ 'type' => 'array', 'items' => ['description' => 'A file link.', 'type' => 'string', 'example' => 'http://xxx.com/a.pptx', 'title' => ''], 'title' => '', 'description' => 'Download links for the exported files.', 'example' => '', ], ], 'description' => 'The response data.', 'example' => '', ], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetPptInfo', 'summary' => 'Gets information about a PPT task.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'GetPptTemplateSelector' => [ 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'example' => 'lm-xxxx', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => ''], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Colour' => [ 'description' => 'The colors.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The color ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Name' => ['title' => '', 'description' => 'The color name.', 'type' => 'string', 'example' => '橙色'], 'Code' => ['title' => '', 'description' => 'The color value.', 'type' => 'string', 'example' => '#FCC462'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SuitStyle' => [ 'description' => 'The styles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The style ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Title' => ['title' => '', 'description' => 'The style name.', 'type' => 'string', 'example' => '扁平简约'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SuitScene' => [ 'description' => 'The scenarios.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The scenario ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Title' => ['title' => '', 'description' => 'The scenario name.', 'type' => 'string', 'example' => '教育培训'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Career' => [ 'description' => 'The careers.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The career ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Name' => ['title' => '', 'description' => 'The career name.', 'type' => 'string', 'example' => '教育培训'], 'IsHot' => ['title' => '', 'description' => 'Indicates whether the career is popular.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query PPT template filter ', 'summary' => 'Retrieves the filters for PowerPoint (PPT) templates.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptTemplateSelector', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"xxxxx\\",\\n \\"Success\\": false,\\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"}]', 'translator' => 'machine', ], 'GetProperties' => [ 'summary' => 'Retrieves configuration information, such as intelligent configuration styles and inference-related metadata configurations.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxx_efm'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'ChatConfig' => ['title' => '', 'description' => 'Call configuration', 'type' => 'object', 'example' => ''], 'ConsoleConfig' => [ 'description' => 'Console configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'TipContent' => ['title' => '', 'description' => 'Prompt content', 'type' => 'string', 'example' => 'xx'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => 'AI妙笔'], ], 'example' => '', ], 'GeneralConfigMap' => ['title' => '', 'description' => 'General configurations map', 'type' => 'object', 'example' => ''], 'IntelligentSearchConfig' => [ 'description' => 'Intelligent search configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'ProductDescription' => ['title' => '', 'description' => 'Homepage product description', 'type' => 'string', 'example' => 'xxx'], 'SearchSamples' => [ 'description' => 'Intelligent search recommendations', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'sample', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'Article list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Article', 'type' => 'object', 'properties' => [ 'Select' => ['title' => '', 'description' => 'Whether manually selected when passed from the frontend', 'type' => 'boolean', 'example' => 'true'], 'Stared' => ['title' => '', 'description' => 'Whether it is a starred article', 'type' => 'boolean', 'example' => 'false'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL', 'type' => 'string', 'example' => 'http://xxx.com'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Prompt' => ['title' => '', 'description' => 'Prompt', 'type' => 'string', 'example' => 'xx'], 'Text' => ['title' => '', 'description' => 'Generated content', 'type' => 'string', 'example' => 'xxx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SearchSources' => [ 'description' => 'Search source list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search source', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Unique identifier for the dataset: code+datasetName', 'type' => 'string', 'example' => 'xx'], 'DatasetName' => ['title' => '', 'description' => 'Unique identifier for the dataset: code+datasetName', 'type' => 'string', 'example' => 'xx'], 'Name' => ['title' => '', 'description' => 'Search source name: Chinese', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'CopilotPreciseSearchSources' => [ 'description' => 'Miaosou: Search source configuration', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Unique identifier for the dataset: code+datasetName', 'type' => 'string', 'example' => 'x'], 'DatasetName' => ['title' => '', 'description' => 'Unique identifier for the dataset: code+datasetName', 'type' => 'string', 'example' => 'x'], 'Name' => ['title' => '', 'description' => 'Search source name: Chinese', 'type' => 'string', 'example' => 'x'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'SearchSources' => [ 'description' => 'Search source dropdown list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search source', 'type' => 'object', 'properties' => [ 'Label' => ['title' => '', 'description' => 'Search source name', 'type' => 'string', 'example' => '夸克通用搜索'], 'Value' => ['title' => '', 'description' => 'Search source code', 'type' => 'string', 'example' => 'SystemSearch'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SlrAuthorized' => ['title' => '', 'description' => 'Whether SLR is authorized', 'type' => 'boolean', 'example' => 'true'], 'UserInfo' => [ 'description' => 'User configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'AgentId' => ['title' => '', 'description' => 'Unique identifier for the workspace', 'type' => 'string', 'example' => '1'], 'TenantId' => ['title' => '', 'description' => 'Unique identifier for the tenant', 'type' => 'string', 'example' => '1'], 'UserId' => ['title' => '', 'description' => 'User ID', 'type' => 'string', 'example' => '1'], 'Username' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'example' => 'admin'], ], 'example' => '', ], 'WanxiangImageSizeConfig' => [ 'description' => 'Wanxiang images', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Wanxiang image size', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'Image aspect ratio', 'type' => 'string', 'example' => '1:1'], 'Value' => ['title' => '', 'description' => 'Image size in pixels', 'type' => 'string', 'example' => '1024*1024'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'WanxiangImageStyleConfig' => [ 'description' => 'Wanxiang image style configuration', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'Style name', 'type' => 'string', 'example' => '默认'], 'Pic' => ['title' => '', 'description' => 'Style image URL', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i4/O1CN01RzKicz1W0YWzYkWcK_!!6000000002726-2-tps-132-104.png'], 'Value' => ['title' => '', 'description' => 'Style code', 'type' => 'string', 'example' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'SearchSourceList' => [ 'description' => 'Specified search source list', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Search source type: corresponds to (SystemSearch: system-built-in search, CustomSemanticSearch: custom semantic index search, ThirdSearch: third-party API search)', 'type' => 'string', 'example' => 'SystemSearch'], 'Name' => ['title' => '', 'description' => 'Search source description', 'type' => 'string', 'example' => '互联网检索'], 'DatasetName' => ['title' => '', 'description' => 'Unique identifier for the data source', 'type' => 'string', 'example' => 'QuarkCommonNews'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'MiaosouConfig' => [ 'description' => 'Miaosou configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'UseDocSize' => ['title' => '', 'description' => 'Number of documents used in the dataset', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'MaxDocSize' => ['title' => '', 'description' => 'The number of active documents in the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'ModelInfos' => [ 'description' => 'Model list supported by intelligent search', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Model supported by intelligent search', 'title' => '', 'type' => 'object', 'properties' => [ 'ModelName' => ['title' => '', 'description' => 'Model name', 'type' => 'string', 'example' => '全妙-Max'], 'ModelId' => ['title' => '', 'description' => 'Model ID', 'type' => 'string', 'example' => 'quanmiao-max'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Whether successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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\\": \\"\\"\\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' => 'Retrieve Configuration Information ', 'changeSet' => [ ['createdAt' => '2025-06-05T11:27:42.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-05-12T11:49:50.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-05-08T06:40:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'GetProperties'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetProperties', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetSmartAuditResult' => [ 'summary' => 'Queries the result of an automated review.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The review result.', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'The task execution status. Valid values: PENDING, RUNNING, SUCCESSED, SUSPENDED, FAILED, and CANCELLED.', 'type' => 'string', 'example' => 'SUCCESSED'], 'ErrorItemDetails' => [ 'description' => 'The list of review error details.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Context' => ['title' => '', 'description' => 'The original text segment.', 'type' => 'string', 'example' => '原文片段'], 'MajorCodeDesc' => ['title' => '', 'description' => 'The description of the primary error.', 'type' => 'string', 'example' => '内容准确性'], 'ErrorWord' => ['title' => '', 'description' => 'The incorrect word.', 'type' => 'string', 'example' => '”xxx“'], 'MajorCode' => ['title' => '', 'description' => 'The primary error code.', 'type' => 'string', 'example' => 'ContentAccuracy'], 'RightWord' => ['title' => '', 'description' => 'The suggested correction.', 'type' => 'string', 'example' => '“xxx”'], 'Reason' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => '中文双引号应成对正确使用，先左双引号，后右双引号'], 'Url' => ['title' => '', 'description' => 'In an image review scenario, this is the public URL of the image that triggered the review.', 'type' => 'string', 'example' => 'http://www.example.com/xxxx.jpg'], 'Offset' => ['title' => '', 'description' => 'The offset index of the incorrect word in the full text.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'CheckId' => ['title' => '', 'description' => 'The unique ID of the review item.', 'type' => 'string', 'example' => '审核项唯一标识。'."\n" ."\n"], 'SubClassCode' => ['title' => '', 'description' => 'The sub-error code.', 'type' => 'string', 'example' => 'PunctuationError'], 'ErrorLevel' => ['title' => '', 'description' => 'The error level. 1: critical, 2: warning, 3: notice, 4: suggestion.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'SubClassDesc' => ['title' => '', 'description' => 'The description of the sub-error.', 'type' => 'string', 'example' => '标点符号错误'."\n"], 'ContextOffset' => ['title' => '', 'description' => 'The offset index of the incorrect word within the context.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ErrorMessage' => ['title' => '', 'description' => 'If the final status is not SUCCESSED, read this error message to identify the fault.', 'type' => 'string', 'example' => '审核被取消'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Query Intelligent Review Result ', 'changeSet' => [ ['createdAt' => '2025-08-04T09:48:13.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetSmartAuditResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetSmartClipTask' => [ 'summary' => 'Queries a one-click video editing task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace. To get the workspace ID, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the task.'."\n" ."\n" .'> You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId for multiple tasks, those tasks belong to the same conversation group.', 'type' => 'string', 'required' => true, 'example' => 'task-03d46184ee7d8749'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Task response', 'title' => '', 'type' => 'object', 'properties' => [ 'Status' => ['title' => '', 'description' => 'Task status:'."\n" .'PENDING: Pending'."\n" .'RUNNING: Running'."\n" .'SUCCESSED: Succeeded'."\n" .'FAILED: Failed'."\n" .'CANCELED: Canceled', 'type' => 'string', 'example' => 'RUNNING'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误信息'], 'SubJobs' => [ 'description' => 'List of subtasks', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Subtask', 'title' => '', 'type' => 'object', 'properties' => [ 'SubJobId' => ['title' => '', 'description' => 'Subtask ID', 'type' => 'string', 'example' => 'xxxxx'], 'Status' => ['title' => '', 'description' => 'Subtask status:'."\n" .'PENDING: Pending'."\n" .'RUNNING: Running'."\n" .'SUCCESSED: Succeeded'."\n" .'FAILED: Failed'."\n" .'CANCELED: Canceled', 'type' => 'string', 'example' => 'RUNNING'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '文件名错误'], 'FileKey' => ['title' => '', 'description' => 'File key', 'type' => 'string', 'example' => 'oss://default/bucket-name/path-xxx/xxx-1.mp4'], 'FileAttr' => [ 'description' => 'File attributes', 'title' => '', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'Video file name', 'type' => 'string', 'example' => '2024-12-12.mp4'], 'FileLength' => ['title' => '', 'description' => 'Video file size', 'type' => 'string', 'example' => '290804'], 'TmpUrl' => ['title' => '', 'description' => 'Temporary URL to access the video file. Expires in one hour.', 'type' => 'string', 'example' => 'http://www.example.com/tmp.mp4'], 'Duration' => ['title' => '', 'description' => 'Video duration in seconds', 'type' => 'number', 'format' => 'double', 'example' => '120'], 'Height' => ['title' => '', 'description' => 'Video height', 'type' => 'integer', 'format' => 'int32', 'example' => '1080'], 'Width' => ['title' => '', 'description' => 'Video width', 'type' => 'integer', 'format' => 'int32', 'example' => '1920'], ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique identifier of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Get Intelligent Video Editing Job Result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetSmartClipTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetStyleLearningResult' => [ 'summary' => 'Retrieves the analysis result of a style learning task.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the style learning task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '39'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'AigcResult' => ['title' => '', 'description' => 'The content generated by AIGC.', 'type' => 'string', 'example' => 'AIGC 生成的内容'], 'ContentList' => [ 'description' => 'A list of custom content entities.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The custom content.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '内容'], 'CreateTime' => ['title' => '', 'description' => 'The time when the content was created.', 'type' => 'string', 'example' => '创建时间'], 'CreateUser' => ['title' => '', 'description' => 'The user who created the content.', 'type' => 'string', 'example' => '创建用户'], 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '标题'], 'UpdateTime' => ['title' => '', 'description' => 'The time when the content was last modified.', 'type' => 'string', 'example' => '修改时间'], 'UpdateUser' => ['title' => '', 'description' => 'The user who last modified the content.', 'type' => 'string', 'example' => '修改用户'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'CustomTextIdList' => [ 'description' => 'A list of custom content IDs.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A custom content ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '25', 'title' => ''], 'example' => '', ], 'Id' => ['title' => '', 'description' => 'The ID of the style learning analysis result.', 'type' => 'integer', 'format' => 'int64', 'example' => '33'], 'MaterialIdList' => [ 'description' => 'A list of material IDs.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The ID of a material in the library.', 'type' => 'integer', 'format' => 'int64', 'example' => '4', 'title' => ''], 'example' => '', ], 'MaterialInfoList' => [ 'description' => 'A list of detailed information about the materials.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者'], 'CreateTime' => ['title' => '', 'description' => 'The time when the material was created.', 'type' => 'string', 'example' => '创建时间'], 'CreateUser' => ['title' => '', 'description' => 'The ID of the user who created the material.', 'type' => 'string', 'example' => '创建用户ID'], 'CreateUserName' => ['title' => '', 'description' => 'The name of the user who created the material.', 'type' => 'string', 'example' => '创建用户姓名'], 'DocKeywords' => [ 'description' => 'The document tags used for purposes such as categorization. Separate keywords with commas.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A keyword.', 'type' => 'string', 'example' => '中欧', 'title' => ''], 'example' => '', ], 'DocType' => ['title' => '', 'description' => 'The document type. Valid values: pdf, word, url, and image.', 'type' => 'string', 'example' => '文档类型，pdf、word、url、image'], 'ExternalUrl' => ['title' => '', 'description' => 'The URL of the file uploaded by the customer. This is for record-keeping only.', 'type' => 'string', 'example' => '外部客户上传的URL，仅用作记录保存'], 'FileLength' => ['title' => '', 'description' => 'The length of the file content.', 'type' => 'integer', 'format' => 'int32', 'example' => '41'], 'HtmlContent' => ['title' => '', 'description' => 'The raw HTML content after parsing.', 'type' => 'string', 'example' => '解析后的原始html内容'], 'Id' => ['title' => '', 'description' => 'The primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '50'], 'PubTime' => ['title' => '', 'description' => 'The publishing time.', 'type' => 'string', 'example' => '发布时间'], 'PublicUrl' => ['title' => '', 'description' => 'A temporary public URL.', 'type' => 'string', 'example' => '临时的对外公开的URL'], 'ShareAttr' => [ 'title' => '', 'description' => 'The sharing property, stored as a bitmask. The first bit indicates sharing within the workspace, the second within the tenant, and the third system-wide.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['0', '1'], ], 'SrcFrom' => ['title' => '', 'description' => 'The source of the document. Valid values: user\\_upload, search, and viewpoint.', 'type' => 'string', 'example' => '文档来源，user_upload、search、viewpoint'], 'Summary' => ['title' => '', 'description' => 'The document summary.', 'type' => 'string', 'example' => '文档摘要'], 'TextContent' => ['title' => '', 'description' => 'The parsed text content. This is empty for images.', 'type' => 'string', 'example' => '解析后的文本内容，对于图片来说为空'], 'ThumbnailInBase64' => ['title' => '', 'description' => 'The Base64-encoded thumbnail for image documents.', 'type' => 'string', 'example' => '图片文档类型的Base64缩略图'], 'Title' => ['title' => '', 'description' => 'The document title.', 'type' => 'string', 'example' => '文档标题'], 'UpdateTime' => ['title' => '', 'description' => 'The time when the material was last modified.', 'type' => 'string', 'example' => '修改时间'], 'UpdateUser' => ['title' => '', 'description' => 'The ID of the user who last modified the material.', 'type' => 'string', 'example' => '修改用户ID'], 'UpdateUserName' => ['title' => '', 'description' => 'The name of the user who last modified the material.', 'type' => 'string', 'example' => '修改用户姓名'], 'Url' => ['title' => '', 'description' => 'The internal storage URL of the document. It supports multiple protocols, such as \\`http\\://\\`, \\`file://\\`, and \\`ftp\\://\\`. This URL is for long-term storage of uploaded files and is deleted on expiration.', 'type' => 'string', 'example' => '内部文档保存的URL，支持多协议，http://,file://,ftp://:客户上传时保存到内部存储的URL、长期保存、到期删除'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'RewriteResult' => ['title' => '', 'description' => 'The user-revised content.', 'type' => 'string', 'example' => '用户修订后内容'], 'StyleName' => ['title' => '', 'description' => 'The user-revised content.', 'type' => 'string', 'example' => '用户修订后内容'], 'TaskId' => ['title' => '', 'description' => 'The ID of the style analysis task.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Retrieve Style Learning Analysis Result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'GetTopicById' => [ 'summary' => 'Retrieve hot topic event information by 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' => '', 'description' => 'Workspace unique identifier: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Data ID', 'type' => 'string', 'required' => true, 'example' => '数据ID'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'AsyncTaskId' => ['title' => '', 'description' => 'Asynchronous task ID (used in custom topic scenarios)', 'type' => 'string', 'example' => '异步任务ID（自定义主题场景下使用）'], 'CreateUser' => ['title' => '', 'description' => 'Creator user ID (used in custom topic scenarios)', 'type' => 'string', 'example' => '创建用户ID（自定义主题场景下使用）'], 'HotValue' => ['title' => '', 'description' => 'Hotness value', 'type' => 'integer', 'format' => 'int64', 'example' => '43'], 'Id' => ['title' => '', 'description' => 'Hot topic ID', 'type' => 'string', 'example' => '热榜ID'], 'Status' => [ 'title' => '', 'description' => 'Asynchronous task status (used in custom event scenarios) (PENDING: pending, RUNNING: running, SUCCESSED: succeeded, SUSPENDED: suspended, FAILED: failed, CANCELED: canceled)', 'type' => 'string', 'example' => 'PENDING', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], ], 'StructureSummary' => [ 'description' => 'List of structured topic summaries', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Structured topic summary object', 'type' => 'object', 'properties' => [ 'DocList' => [ 'description' => 'Articles referenced to generate the title summary', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Article object', 'type' => 'object', 'properties' => [ 'Source' => ['description' => 'Article source', 'type' => 'string', 'example' => '头条', 'title' => ''], 'Title' => ['description' => 'Article title', 'type' => 'string', 'example' => '文章标题', 'title' => ''], 'Url' => ['description' => 'Article URL', 'type' => 'string', 'example' => 'http://www.example.com', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => '摘要'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '标题'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Summary' => ['title' => '', 'description' => 'Hot topic summary', 'type' => 'string', 'example' => '热榜摘要'], 'TaskErrorMessage' => ['title' => '', 'description' => 'Error message for asynchronous task failure', 'type' => 'string', 'example' => '异步任务失败错误信息'], 'TaskStatus' => ['title' => '', 'description' => 'Asynchronous task status. 0: pending, 1: running, 2: succeeded, 3: suspended (not used), 4: failed, 6: canceled (used in custom event scenarios).', 'type' => 'integer', 'format' => 'int32', 'example' => '14'], 'Topic' => ['title' => '', 'description' => 'Unique topic name', 'type' => 'string', 'example' => '主题唯一名称'], 'TopicSource' => ['title' => '', 'description' => 'Hot topic source. Supported sources:'."\n" ."\n" .'- Toutiao: Toutiao'."\n" ."\n" .'- Quark: Quark'."\n" ."\n" .'- Baidu: Baidu'."\n" ."\n" .'- Sina: Sina'."\n" ."\n" .'- Custom: Custom'."\n" ."\n" .'- Aggregation: Hot Topic List', 'type' => 'string', 'example' => 'Toutiao'], 'Version' => ['title' => '', 'description' => 'Data version', 'type' => 'string', 'example' => '数据版本'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve hot spot object ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetTopicById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'GetTopicSelectionPerspectiveAnalysisTask' => [ 'summary' => 'Retrieves the result of a topic selection perspective analysis task.', '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' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> This parameter is optional. The system automatically generates a task ID. If subsequent tasks have the same TaskId, they are considered part of the same conversation.', 'type' => 'string', 'example' => 'c9f226b02cca4f42a84c5e955c39dfd2', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'FreshViewPointsResult' => [ 'description' => 'The analysis result of novel topic selection perspectives.', 'title' => '', 'type' => 'object', 'properties' => [ 'Attitudes' => [ 'description' => 'A list of viewpoints for novel topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Attitude' => ['title' => '', 'description' => 'The current viewpoint.', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['title' => '', 'description' => 'The type of the viewpoint.', 'type' => 'string', 'example' => '观点类型'], 'Ratio' => ['title' => '', 'description' => 'The proportion of the current viewpoint.', 'type' => 'string', 'example' => '当前观点占比'], 'ViewPoints' => [ 'description' => 'A list of topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'The outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A list of outlines.', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'The summary of the outline.', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['title' => '', 'description' => 'The generated perspective.', 'type' => 'string', 'example' => '视角'], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'HotViewPointsResult' => [ 'description' => 'The analysis result of hot topic selection perspectives.', 'title' => '', 'type' => 'object', 'properties' => [ 'Attitudes' => [ 'description' => 'A list of viewpoints for hot topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A list of viewpoints for hot topic selection perspectives.', 'type' => 'object', 'properties' => [ 'Attitude' => ['title' => '', 'description' => 'The current viewpoint.', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['title' => '', 'description' => 'The type of the viewpoint.', 'type' => 'string', 'example' => '观点类型'], 'News' => [ 'description' => 'A list of related news.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A news object.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The news content.', 'type' => 'string', 'example' => 'Content'], 'DocId' => ['description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '9957175DEDCF49C5ACF7A956B4FD67B2', 'title' => ''], 'DocUuid' => ['title' => '', 'description' => 'The unique ID of the article.', 'type' => 'string', 'example' => '"123456"'], 'ImageUrls' => [ 'description' => 'The URLs of the images in the article.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The external link to an image in the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.png', 'title' => ''], 'example' => 'https://www.example.com/aaa.png', ], 'Source' => ['title' => '', 'description' => 'The source of the news.', 'type' => 'string', 'example' => '夸克'], 'Summary' => ['title' => '', 'description' => 'The summary of the news.', 'type' => 'string', 'example' => '新闻摘要'], 'Tags' => [ 'description' => 'The tags.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The tags of the article.', 'type' => 'string', 'example' => '["标签1","标签2"]', 'title' => ''], 'example' => '["标签1","标签2"]', ], 'Title' => ['title' => '', 'description' => 'The title of the news.', 'type' => 'string', 'example' => '新闻标题'], 'Topic' => ['title' => '', 'description' => 'The topic of the article.', 'type' => 'string', 'example' => '文章主题'], 'Url' => ['title' => '', 'description' => 'The URL of the news.', 'type' => 'string', 'example' => 'http://www.example.com'], 'CreateTime' => ['title' => '', 'description' => 'The time when the article was created.', 'type' => 'string', 'example' => '2024-05-08 02:23:01'], 'PubTime' => ['title' => '', 'description' => 'The time when the article was published.', 'type' => 'string', 'example' => '2024-05-08 02:23:02'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Ratio' => ['title' => '', 'description' => 'The proportion of the current viewpoint.', 'type' => 'string', 'example' => '当前观点占比'], 'ViewPoints' => [ 'description' => 'A list of topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'The outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An outline object.', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'The summary of the outline.', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['title' => '', 'description' => 'The generated perspective.', 'type' => 'string', 'example' => '视角'], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'Status' => [ 'title' => '', 'description' => 'The status of the task. Valid values: PENDING, RUNNING, SUCCESSED, SUSPENDED, FAILED, and CANCELED.', 'type' => 'string', 'example' => 'SUSPENDED', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], ], 'TimedViewPointsResult' => [ 'description' => 'The analysis result of time-sensitive topic selection perspectives.', 'title' => '', 'type' => 'object', 'properties' => [ 'Attitudes' => [ 'description' => 'A list of viewpoints for time-sensitive topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A viewpoint object.', 'type' => 'object', 'properties' => [ 'Attitude' => ['title' => '', 'description' => 'The current viewpoint.', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['title' => '', 'description' => 'The type of the viewpoint.', 'type' => 'string', 'example' => '观点类型'], 'PubTime' => ['title' => '', 'description' => 'The time when the viewpoint was published.', 'type' => 'string', 'example' => '2024-01-22 10:29'], 'Ratio' => ['title' => '', 'description' => 'The proportion of the current viewpoint.', 'type' => 'string', 'example' => '当前观点占比'], 'Source' => ['title' => '', 'description' => 'The source of the news.', 'type' => 'string', 'example' => '新浪'], 'Title' => ['title' => '', 'description' => 'The current viewpoint. This is the same as the news title.', 'type' => 'string', 'example' => '标题'], 'Url' => ['title' => '', 'description' => 'The URL of the news.', 'type' => 'string', 'example' => 'http://www.example.com/news/1.html'], 'ViewPoints' => [ 'description' => 'A list of topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A perspective object.', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'The outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An outline object.', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'The summary of the outline.', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['title' => '', 'description' => 'The generated perspective.', 'type' => 'string', 'example' => '视角'], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'Topic' => ['title' => '', 'description' => 'The hot spot topic event.', 'type' => 'string', 'example' => '热点主题事件'], 'TopicSummaryResult' => [ 'description' => 'The summary of the hot spot topic event.', 'title' => '', 'type' => 'object', 'properties' => [ 'Summaries' => [ 'description' => 'A list of summaries.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A summary object.', 'type' => 'object', 'properties' => [ 'DocList' => [ 'description' => 'The articles referenced to generate the summary for this title.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An article object.', 'type' => 'object', 'properties' => [ 'Source' => ['description' => 'The source of the article.', 'type' => 'string', 'example' => '头条', 'title' => ''], 'Title' => ['description' => 'The title of the article.', 'type' => 'string', 'example' => '标题', 'title' => ''], 'Url' => ['description' => 'The URL of the article.', 'type' => 'string', 'example' => 'http://www.example.com', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '摘要'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '标题'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'WebReviewPointsResult' => [ 'description' => 'The analysis result of online review topic selection perspectives.', 'title' => '', 'type' => 'object', 'properties' => [ 'Attitudes' => [ 'description' => 'A list of viewpoints from online reviews for topic selection.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Attitude' => ['title' => '', 'description' => 'The current viewpoint.', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['title' => '', 'description' => 'The type of the viewpoint.', 'type' => 'string', 'example' => '观点类型'], 'Comments' => [ 'description' => 'A list of user comments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An object.', 'type' => 'object', 'properties' => [ 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '来源'], 'Text' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '内容'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '标题'], 'Url' => ['title' => '', 'description' => 'The URL where the comment is located.', 'type' => 'string', 'example' => '当前所属的URL'], 'Username' => ['title' => '', 'description' => 'The username.', 'type' => 'string', 'example' => '用户名'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Ratio' => ['title' => '', 'description' => 'The proportion of the current viewpoint.', 'type' => 'string', 'example' => '当前观点占比'], 'ViewPoints' => [ 'description' => 'A list of topic selection perspectives.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'The outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An outline object.', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'The summary of the outline.', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['title' => '', 'description' => 'The generated perspective.', 'type' => 'string', 'example' => '视角'], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain Job Result of Subject Perspective Analysis ', 'changeSet' => [ ['createdAt' => '2024-10-28T03:52:21.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-09-19T13:07:53.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ImportInterveneFile' => [ 'summary' => 'Imports an intervention file.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'DocName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the uploaded file.', 'type' => 'string', 'required' => false, 'example' => 'import.xls'], ], [ 'name' => 'FileUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'URL of the file.', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/xxx.xls'], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'OSS key of the file.', 'type' => 'string', 'required' => false, 'example' => 'import.xsl'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'FailIdList' => [ 'description' => 'List of failed index IDs.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'ID of a failed intervention item.', 'type' => 'string', 'example' => '123456', 'title' => ''], 'example' => '', ], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => '"3f7045e099474ba28ceca1b4eb6d6e21"'], 'Code' => ['description' => 'Intervention status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. Set to true for success or false for failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Synchronize and import an intervention item file', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:ImportInterveneFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ImportInterveneFileAsync' => [ 'summary' => 'Asynchronously import an intervention file.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'DocName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the uploaded file', 'type' => 'string', 'required' => false, 'example' => 'import.xls'], ], [ 'name' => 'FileUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'File URL', 'type' => 'string', 'required' => false, 'example' => 'https://xxx/import.xls'], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'OSS key of the file', 'type' => 'string', 'required' => false, 'example' => 'import.xls'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'FailIdList' => [ 'description' => 'List of failed index IDs', 'title' => '', 'type' => 'array', 'items' => ['description' => 'ID of a failed intervention item', 'type' => 'string', 'example' => '123', 'title' => ''], 'example' => '', ], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Code' => ['description' => 'Status code returned by the intervention service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. true means success. false means failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Asynchronously import an intervention item file', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:ImportInterveneFileAsync', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'InitiatePptCreation' => [ 'summary' => 'Important: This is a billable API operation.'."\n" .'This API performs two operations:'."\n" .'1\\. Returns the initialization code for the "PPT Generation" frontend component.'."\n" .'2\\. Performs billing.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'llm-3fy94b2rtadt01qa'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'required' => true, 'example' => '95c2fbe6-5a20-4fc2-8a93-376ed05fbe13'], ], [ 'name' => 'Outline', 'in' => 'formData', 'schema' => ['description' => 'The outline.', 'type' => 'string', 'required' => false, 'example' => '# 中国传统文化艺术的魅力'."\n" ."\n" .'## 1. 传统文化艺术的源远流长'."\n" ."\n" .'### 1.1 中国古代艺术发展历程'."\n" ."\n" .'#### 1.1.1 古代绘画艺术的演变'."\n" .'- 从新石器时代的彩陶绘画到东汉时期帛画的出现，绘画形式不断丰富，展现了古人对美的独特追求。唐代绘画风格多样，吴道子的《送子天王图》线条流畅，色彩绚丽，体现了唐代绘画的高超技艺。'."\n" ."\n" .'#### 1.1.2 书法艺术的传承与创新'."\n" .'- 书法从甲骨文到楷书、行书、草书，历经数千年演变，承载着中华文化的深厚内涵。王羲之的《兰亭序》被誉为“天下第一行书”，其笔法精妙，结构严谨，展现了书法艺术的巅峰。', 'title' => ''], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '11AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'AppKey' => ['title' => '', 'description' => 'The AppKey.', 'type' => 'string', 'example' => 'S1X5ecouBztZelaQ'], 'Code' => ['title' => '', 'description' => 'The code.', 'type' => 'string', 'example' => '7dhqd2'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Initialize a session for PPT creation ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:InitiatePptCreation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'translator' => 'machine', ], 'InitiatePptCreationV2' => [ 'summary' => 'Starts a task to create a presentation.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-2setzb9x4ewsd'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the task.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '8a7dfece-f204-4380-a7d0-a13d37de3924'], ], [ 'name' => 'ProcessType', 'in' => 'formData', 'schema' => [ 'description' => 'The type of process to initiate. Valid values:
'."\n" .'`0`: Generates only a signature to initialize the front-end SDK for the full creation process.
'."\n" .'`1`: Generates a signature and a process ID. Use this option if you have a custom front-end page for templates before you initialize the SDK.
'."\n" .'`2`: Generates an artifact ID, which allows for direct editing of the artifact.
'."\n" .'`3`: Generates an export task ID. You can poll this ID to retrieve the export result.



', 'type' => 'integer', 'format' => 'int32', 'enum' => ['0', '1', '2', '3'], 'title' => '', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PptTemplateType', 'in' => 'formData', 'schema' => [ 'description' => 'The template type. The default value is `1`. Valid values: `1` (system template) and `2` (enterprise template).', 'type' => 'integer', 'format' => 'int32', 'enum' => ['1', '2'], 'title' => '', 'required' => false, 'example' => '1', ], ], [ 'name' => 'PptTemplateId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the PPT template.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '500'], ], [ 'name' => 'PptTitle', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => '中国传统文化艺术的魅力', 'title' => '', 'description' => ''], ], [ 'name' => 'Outline', 'in' => 'formData', 'schema' => ['description' => 'The presentation outline, formatted in Markdown.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '# 中国传统文化艺术的魅力'."\n" ."\n" .'## 1. 传统文化艺术的源远流长'."\n" ."\n" .'### 1.1 中国古代艺术发展历程'."\n" ."\n" .'#### 1.1.1 古代绘画艺术的演变'."\n" .'- 从新石器时代的彩陶绘画到东汉时期帛画的出现，绘画形式不断丰富，展现了古人对美的独特追求。唐代绘画风格多样，吴道子的《送子天王图》线条流畅，色彩绚丽，体现了唐代绘画的高超技艺。'."\n" ."\n" .'#### 1.1.2 书法艺术的传承与创新'."\n" .'- 书法从甲骨文到楷书、行书、草书，历经数千年演变，承载着中华文化的深厚内涵。王羲之的《兰亭序》被誉为“天下第一行书”，其笔法精妙，结构严谨，展现了书法艺术的巅峰。'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the external user.', 'type' => 'string', 'example' => 'abc', 'title' => '', 'required' => false], ], [ 'name' => 'IsMobile', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether the request originates from a mobile client.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'Code' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误消息', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'Data' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'AppKey' => ['description' => 'The AppKey for initializing the front-end component.', 'type' => 'string', 'title' => '', 'example' => 'S1X5ecouBztZelaQ'], 'Signature' => ['description' => 'The signature for initializing the front-end component.', 'type' => 'string', 'title' => '', 'example' => 'dBBGvT0Toje5887Qw+/IwwMNYfk='], 'PptProcessId' => ['description' => 'The process ID for creating the PPT, used to initialize the front-end component for artifact creation.', 'type' => 'string', 'title' => '', 'example' => '8485143'], 'PptArtifactId' => ['description' => 'The artifact ID. Use this ID to edit the artifact.', 'type' => 'string', 'title' => '', 'example' => '53059801'], 'PptArtifactCover' => ['description' => 'The URL of the artifact cover.', 'type' => 'string', 'title' => '', 'example' => 'http://a.com/xxx.png'], 'ExportTaskId' => ['description' => 'The ID of the export task.', 'type' => 'string', 'title' => '', 'example' => '66b25058-d735-47e5-a534-5da93453d3df'], 'Alert' => ['description' => 'An alert message related to service usage or status.', 'type' => 'string', 'example' => '本月版本内的配送额度已经用尽，超额使用将走按量后付费，下个月配送额度将重新下发；请知晓', 'title' => ''], ], 'description' => 'The returned data.', 'example' => '', ], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'InitiatePptCreationV2', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:InitiatePptCreationV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'InsertInterveneGlobalReply' => [ 'summary' => 'Sets global intervention replies.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxx_efm'], ], [ 'name' => 'ReplyMessagList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of reply content', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Message' => ['title' => '', 'description' => 'Reply content', 'type' => 'string', 'required' => false, 'example' => '抱歉，问题我无法回答'], 'ReplyType' => [ 'title' => '', 'description' => 'Reply type', 'enumValueTitles' => ['namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A input intervention)', 'namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A result intervention)', 'namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (writing result intervention)', 'namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (writing input intervention)'], 'type' => 'string', 'required' => false, 'example' => '全局回复的类型', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'status code', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'FailIdList' => [ 'description' => 'List of failed index IDs', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Error ID', 'type' => 'string', 'example' => '1234', 'title' => ''], 'example' => '', ], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '4829'], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Whether successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Insert global intervention response item', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:InsertInterveneGlobalReply', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'InsertInterveneRule' => [ 'summary' => 'Insert an intervention rule.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'InterveneRuleConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Intervention rule configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'AnswerConfig' => [ 'description' => 'Answer configuration', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Answer configuration item', 'type' => 'object', 'properties' => [ 'AnswerType' => [ 'title' => '', 'description' => 'Answer type', 'enumValueTitles' => ['1-定向回复' => '1-Targeted reply', ' 0-统一回复' => '0\\. Unified Response'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Message' => ['title' => '', 'description' => 'Answer content', 'type' => 'string', 'required' => false, 'example' => '抱歉我无法回答'], 'Namespace' => [ 'title' => '', 'description' => 'Namespace', 'enumValueTitles' => [' namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (writing input intervention)', ' namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A result intervention)', 'namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A input intervention)', ' namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (writing result intervention)'], 'type' => 'string', 'required' => false, 'example' => 'namespace_qa_query', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'EffectConfig' => [ 'description' => 'Activation configuration', 'title' => '', 'type' => 'object', 'properties' => [ 'EffectType' => [ 'title' => '', 'description' => 'Activation type', 'enumValueTitles' => ['0-永久生效 ' => '0 – Takes effect permanently', '1-按时间生效' => '1\\. Effective on a schedule'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'EndTime' => ['title' => '', 'description' => 'End time', 'type' => 'string', 'required' => false, 'example' => '2023-03-28 06:04:29'], 'StartTime' => ['title' => '', 'description' => 'Start time', 'type' => 'string', 'required' => false, 'example' => '2023-03-28 06:04:29'], ], 'required' => false, 'example' => '', ], 'InterveneConfigList' => [ 'description' => 'Intervention configuration list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'ID', 'type' => 'string', 'required' => false, 'example' => '37249'], 'OperationType' => [ 'title' => '', 'description' => 'Operation type', 'enumValueTitles' => ['0-新建' => '0 – Create', ' 1-更新 ' => '1\\. Update', '2-删除' => '2-Delete'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'Query' => ['title' => '', 'description' => 'Intervention query configuration', 'type' => 'string', 'required' => false, 'example' => '早上好'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'InterveneType' => [ 'title' => '', 'description' => 'Intervention type', 'enumValueTitles' => ['0-相似问干预项目' => '0-Similar question intervention project', ' 2-正则表达式干预项 ' => '2\\. Regular expression intervention items', '3-关键词库干预项' => '3\\. Keyword library interventions', ' 4-URL干预' => '4\\. URL intervention', '1-关键词表达式干预项' => '1\\. Keyword expression intervention item'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', ], 'NamespaceList' => [ 'description' => 'Namespace list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Intervention dimension', 'enumValueTitles' => ['namespace_writing_image （智能配图）' => 'namespace\\_writing\\_image (Smart Image Matching)', 'namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A input intervention)', 'namespace_qa_article （问答参考）' => 'namespace\\_qa\\_article (Q\\&A pair reference)', 'namespace_writing_article （写作参考）' => 'namespace\\_writing\\_article (writing reference)', 'namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A pair result intervention)', 'namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (writing result intervention)', 'namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (writing input intervention)'], 'type' => 'string', 'required' => false, 'example' => 'namespace_qa_query'."\n" .'（问答输入干预）', 'title' => '', ], 'required' => false, 'example' => '', ], 'RuleId' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], 'RuleName' => ['title' => '', 'description' => 'Rule name', 'type' => 'string', 'required' => false, 'example' => 'tf-test-rule'], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'RuleId' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], 'Code' => ['description' => 'Status code returned by the intervention service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => 'DD656AF9-0839-521A-A3D2-F320009F9C87'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Insert intervention rule', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:InsertInterveneRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListAnalysisTagDetailByTaskId' => [ 'summary' => 'Retrieves a paginated list of details for an enterprise Voice of the Customer (VOC) analysis task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> This parameter is optional. The system automatically generates a task ID. If you specify the same TaskId for multiple tasks, the tasks are considered part of the same conversation.', 'type' => 'string', 'required' => true, 'example' => 'xxx'], ], [ 'name' => 'Categories', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of categories for filtering.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A category for filtering.', 'type' => 'string', 'required' => false, 'example' => '分类1'], 'required' => false, 'example' => '', ], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'token-xxxx', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The maximum number of entries to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of records to request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3'], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'A list of classification details from the tag mining task.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The details of a tag mining classification.', 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The primary key ID of the data.', 'type' => 'integer', 'format' => 'int64', 'example' => '112'], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'xxx'], 'TagTaskType' => ['title' => '', 'description' => 'The type of the tag mining task. Valid values: \\`singleTagValue\\`, \\`multiTagValues\\`, and \\`summaryAndOverview\\`.', 'type' => 'string', 'example' => 'summaryAndOverview'], 'Content' => ['title' => '', 'description' => 'The content of the tag.', 'type' => 'string', 'example' => 'xxx'], 'ContentTags' => [ 'description' => 'A list of tags applied to the content.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A list of tag values.', 'title' => '', 'type' => 'object', 'properties' => [ 'TagName' => ['title' => '', 'description' => 'The name of the tag.', 'type' => 'string', 'example' => 'xxx'], 'SummaryOverview' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => 'xxx'], 'Tags' => [ 'description' => 'A list of tag values.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A tag value.', 'type' => 'string', 'example' => '标签值列表'], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'NextToken' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => 'token-xxxx'], 'MaxResults' => ['title' => '', 'description' => 'The maximum number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve Tag Analysis Details List by Job ID ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ListAnalysisTagDetailByTaskId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListAsyncTasks' => [ 'summary' => 'Retrieves a list of asynchronous tasks.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'], ], [ 'name' => 'TaskName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'A term query for the task name.', 'type' => 'string', 'required' => false, 'example' => '任务名称'], ], [ 'name' => 'TaskCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'A term query for the task code.', 'type' => 'string', 'required' => false, 'example' => 'MaterialDocumentUpload'], ], [ 'name' => 'TaskType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'A term query for the task type.', 'type' => 'string', 'required' => false, 'example' => '暂无'], ], [ 'name' => 'TaskStatus', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'A term query for the task status. Valid values: 0 (Pending), 1 (Running), 2 (Succeeded), 3 (Paused), 4 (Failed and retriable), 5 (Failed and not retriable), and 6 (Canceled).', 'type' => 'integer', 'format' => 'int32', 'enum' => ['0', '1', '2', '3', '4', '5', '6'], 'required' => false, 'example' => '1', ], ], [ 'name' => 'TaskStatusList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A term query for a list of task statuses. Valid values: 0 (Pending), 1 (Running), 2 (Succeeded), 3 (Paused), 4 (Failed and retriable), 5 (Failed and not retriable), and 6 (Canceled).', 'title' => '', 'type' => 'array', 'items' => [ 'title' => '', 'description' => 'The task status.', 'type' => 'integer', 'format' => 'int32', 'enum' => ['0', '1', '2', '3', '4', '5', '6'], 'required' => false, 'example' => '1', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'TaskTypeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A term query for a list of task types.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The task category.', 'type' => 'string', 'example' => 'test', 'required' => false], 'required' => false, 'example' => '', ], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The start of the time range to query task creation times. Format: YYYY-MM-DD HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11'], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The end of the time range to query task creation times. Format: YYYY-MM-DD HH:mm:ss.', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PageResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Current' => ['description' => 'The current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'description' => 'The list of tasks.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['title' => '', 'description' => 'The creation date.', 'type' => 'string', 'example' => '2020-12-23 15:41:58'], 'CreateUser' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => '1111'], 'Id' => ['description' => 'The primary key ID of the task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TaskCode' => ['title' => '', 'description' => 'The task identifier, which specifies the task.', 'type' => 'string', 'example' => 'MaterialDocumentUpload'], 'TaskDefinition' => ['title' => '', 'description' => 'The optional task definition configuration in JSON format. These parameters overwrite the system\'s default configuration.', 'type' => 'string', 'example' => '{}'], 'TaskEndTime' => ['title' => '', 'description' => 'The actual end time of the task.', 'type' => 'string', 'example' => '2023-03-09 00:00:00'], 'TaskErrorMessage' => ['title' => '', 'description' => 'The error message from the task execution for the client.', 'type' => 'string', 'example' => '系统内部错误'], 'TaskExecuteTime' => ['title' => '', 'description' => 'The time when the task is scheduled to run. The system polls only for tasks that are due. If this parameter is empty, the task runs immediately.', 'type' => 'string', 'example' => '2023-10-14 14:30:00'], 'TaskId' => ['title' => '', 'description' => 'The unique task ID. It is equivalent to the Id parameter.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskInnerErrorMessage' => ['title' => '', 'description' => 'The internal error message from the task execution. Sensitive information, such as exception stacks and internal thread stacks, is recorded here.', 'type' => 'string', 'example' => '系统错误'], 'TaskIntermediateResult' => ['title' => '', 'description' => 'The intermediate result of the task execution. If a task consists of multiple steps, the output of each step can be saved here. When the task resumes from a paused state, it can read this intermediate result and continue execution.', 'type' => 'string', 'example' => '{}'], 'TaskName' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => '任务名'], 'TaskParam' => ['title' => '', 'description' => 'The input parameters for the task execution, in JSON format.', 'type' => 'string', 'example' => '{}'], 'TaskProgressMessage' => ['title' => '', 'description' => 'The progress information of the task execution.', 'type' => 'string', 'example' => '{}'], 'TaskResult' => ['title' => '', 'description' => 'The result information of the task execution.', 'type' => 'string', 'example' => '{}'], 'TaskRetryCount' => ['title' => '', 'description' => 'The number of times the task has been retried.', 'type' => 'string', 'example' => '1'], 'TaskStartTime' => ['title' => '', 'description' => 'The actual start time of the task.', 'type' => 'string', 'example' => '2023-03-20 10:53:00'], 'TaskStatus' => ['title' => '', 'description' => 'The execution status of the task. Valid values: 0 (Pending), 1 (Running), 2 (Succeeded), 3 (Paused), 4 (Failed and retriable), 5 (Failed and not retriable), 6 (Canceled).', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'TaskType' => ['title' => '', 'description' => 'The task categories. Multiple categories are separated by commas.', 'type' => 'string', 'example' => 'test'], 'UpdateTime' => ['title' => '', 'description' => 'The update date.', 'type' => 'string', 'example' => '2023-02-16 10:29:16'], 'UpdateUser' => ['title' => '', 'description' => 'The user who performed the update.', 'type' => 'string', 'example' => '111'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'], 'Size' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. true: The request was successful. false: The request failed.', 'type' => 'boolean', 'example' => 'true'], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve asynchronous task list ', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListAsyncTasks'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAsyncTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListAuditContentErrorTypes' => [ 'summary' => 'Retrieves a list of audit dimensions.', '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' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Maximum number of records', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2000', 'minimum' => '0', 'required' => false, 'example' => '100'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Token for the next page', 'type' => 'string', 'required' => false, 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Data' => [ 'description' => 'List of audit dimensions', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Main audit dimension', 'title' => '', 'type' => 'object', 'properties' => [ 'MajorClassCode' => ['title' => '', 'description' => 'Main audit dimension code', 'type' => 'string', 'example' => 'ContentAccuracy'], 'SubClasses' => [ 'description' => 'List of sub-audit dimensions', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Sub-audit dimension', 'title' => '', 'type' => 'object', 'properties' => [ 'ClassCode' => ['title' => '', 'description' => 'Sub-audit dimension code', 'type' => 'string', 'example' => 'PunctuationError'], 'ClassName' => ['title' => '', 'description' => 'Sub-audit dimension name', 'type' => 'string', 'example' => '标点符号错误'], ], 'example' => '', ], 'example' => '', ], 'MajorClassName' => ['title' => '', 'description' => 'Sub-audit dimension name', 'type' => 'string', 'example' => '内容准确性'], ], 'example' => '', ], 'example' => '', ], 'NextToken' => ['title' => '', 'description' => 'Token for the next page', 'type' => 'string', 'example' => '下一页的token'], 'TotalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'MaxResults' => ['title' => '', 'description' => 'Maximum number of records returned in this response', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Obtain the review dimension list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAuditContentErrorTypes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListAuditTerms' => [ 'summary' => 'Retrieve a list of term libraries.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. Get your [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Token for the next page.', 'type' => 'string', 'example' => 'XXXX', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of records to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'TermsName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Dictionary name. Optional. Defaults to Default if not specified.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Indicates whether deletion succeeded.', 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Task primary key ID', 'type' => 'string', 'example' => '1'], 'Keyword' => ['title' => '', 'description' => 'Keyword', 'type' => 'string', 'example' => '龘'], 'SuggestWord' => ['title' => '', 'description' => 'Suggested word', 'type' => 'string', 'example' => '龘(dá)'], 'TermsDesc' => ['title' => '', 'description' => 'Audit basis', 'type' => 'string', 'example' => '龙行龘龘出自四库本《玉篇》23龙部第8字，文字释义为群龙腾飞的样子，昂扬而热烈。'], 'ExceptionWord' => [ 'description' => 'Exception statements', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Dictionary name', 'type' => 'string', 'example' => ''], 'example' => '', ], 'TermsName' => ['title' => '', 'description' => 'Dictionary name', 'type' => 'string', 'example' => ''], ], 'example' => '', ], 'example' => '', ], 'MaxResults' => ['title' => '', 'description' => 'Maximum number of results returned', 'type' => 'integer', 'format' => 'int32', 'example' => '77'], 'NextToken' => ['title' => '', 'description' => 'Token for the next page', 'type' => 'string', 'example' => 'x\'x\'x'], 'TotalCount' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '58'], ], 'example' => '', ], ], ], '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 {\\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' => 'Retrieve custom dictionary records', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-08-15T05:32:39.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListAutoClipsTask' => [ 'summary' => 'Lists smart video editing tasks.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Model Studio workspace', 'type' => 'string', 'required' => false, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'formData', 'schema' => ['description' => 'Task name', 'type' => 'string', 'required' => false, 'example' => 'task001', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'formData', 'schema' => ['description' => 'Task type', 'type' => 'string', 'required' => false, 'example' => 'type001', 'title' => ''], ], [ 'name' => 'TaskStatus', 'in' => 'formData', 'schema' => ['description' => 'Task status', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['description' => 'The start time of the task.', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11', 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The task end time.', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00', 'title' => ''], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['description' => 'Number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'formData', 'schema' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Deprecated', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'title' => '', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded. true means success. false means failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'MaxResults' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], 'NextToken' => ['description' => 'Deprecated', 'type' => 'string', 'example' => 'null', 'title' => ''], 'TotalCount' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], 'Current' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Size' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Total' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'example' => '任务名称', 'title' => ''], 'TaskType' => ['description' => 'Task type', 'type' => 'string', 'example' => 'type001', 'title' => ''], 'TaskStatus' => ['description' => 'Task status', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'TaskStep' => ['description' => 'upload', 'type' => 'string', 'example' => 'upload'."\n" .'clips'."\n" .'generate', 'title' => ''], 'CreateTimeStart' => ['description' => 'Start time of task creation', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n", 'title' => ''], ], 'description' => 'Business data', 'title' => '', 'example' => '', ], 'description' => 'Business data', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Response schema', 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListAutoClipsTask', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAutoClipsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'ListBiddingDoc' => [ 'summary' => 'Retrieves the list of bidding document writing tasks.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xx', 'title' => ''], ], [ 'name' => 'TaskName', 'in' => 'formData', 'schema' => ['description' => 'Defines the task name.', 'type' => 'string', 'required' => false, 'example' => '任务名称', 'title' => ''], ], [ 'name' => 'TaskStatus', 'in' => 'formData', 'schema' => ['description' => 'Task status', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0-waiting、1-running、2-success、3-pause、4-fail', 'title' => ''], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['description' => 'Start creation time, in timestamp format.', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11', 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'End creation time, in timestamp format.', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00', 'title' => ''], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['description' => 'Number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'formData', 'schema' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => 'null', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Deprecated', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error description', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Whether the operation was successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'MaxResults' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], 'NextToken' => ['description' => 'Deprecated', 'type' => 'string', 'example' => 'null', 'title' => ''], 'TotalCount' => ['description' => 'Deprecated', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], 'Current' => ['description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Size' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Total' => ['description' => 'Total records', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Data' => [ 'description' => 'Returned data', 'type' => 'array', 'items' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TaskName' => ['description' => 'Task name', 'type' => 'string', 'example' => '任务名称', 'title' => ''], 'TaskStatus' => ['description' => 'Task status', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'CreateTimeStart' => ['description' => 'Creation time - start range, format: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n", 'title' => ''], 'TaskStep' => ['description' => 'Task step', 'type' => 'string', 'example' => 'analysis'."\n" .'writing', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'List Bid Writing Jobs ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListBuildConfigs' => [ 'summary' => 'Retrieves the system-defined presets for the Generate Content workflow. These presets include options such as writing style, article length, output language, and the number of articles to generate.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'cd327c3d5d5e44159cc716e23bfa530e_p_beebot_public'], ], [ 'name' => 'Type', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Content category. Valid values: media or government.', 'enumValueTitles' => ['market' => 'Marketing content', 'government' => 'Government content', 'media' => 'Media content', 'office' => 'Office content'], 'type' => 'string', 'default' => 'media', 'enum' => ['media', 'government', 'custom'], 'required' => false, 'example' => 'media', ], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult\\>', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => '200'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Business object', 'type' => 'object', 'properties' => [ 'BuildIn' => ['title' => '', 'description' => 'Indicates whether the preset is built-in', 'type' => 'boolean', 'example' => 'true'], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2023-04-11 06:14:07'], 'CreateUser' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '1'], 'Id' => ['title' => '', 'description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '主键ID，内置配置（buildIn=true）无该字段'], 'Keywords' => [ 'description' => 'List of available values for the tag', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Definition of an available tag value', 'title' => '', 'type' => 'object', 'properties' => [ 'Description' => ['title' => '', 'description' => 'Description of the preset tag', 'type' => 'string', 'example' => '新闻内容'], 'Key' => ['title' => '', 'description' => 'Key of the preset tag', 'type' => 'string', 'example' => '新闻内容'], ], 'example' => '', ], 'example' => '', ], 'Tag' => ['title' => '', 'description' => 'Tag key', 'type' => 'string', 'example' => 'writingStyle'], 'TagDescription' => ['title' => '', 'description' => 'Tag description', 'type' => 'string', 'example' => '文体'], 'Type' => ['title' => '', 'description' => 'Content category. Valid values: media or government.', 'type' => 'string', 'example' => 'media'], 'UpdateTime' => ['title' => '', 'description' => 'Last update time', 'type' => 'string', 'example' => '2023-04-11 06:14:07'."\n"], 'UpdateUser' => ['title' => '', 'description' => 'Last updater', 'type' => 'string', 'example' => '1'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'Success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Retrieve system custom presets ', 'changeSet' => [ ['createdAt' => '2025-04-18T07:54:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListBuildConfigs'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ListBuildConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListCustomText' => [ 'summary' => 'Retrieve a list of custom texts.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'CommodityCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Commodity code.', 'type' => 'string', 'example' => '商品code', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Document object.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Content.', 'type' => 'string', 'example' => '内容'], 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '创建时间'], 'CreateUser' => ['title' => '', 'description' => 'The user who created the custom text.', 'type' => 'string', 'example' => '创建用户'], 'Id' => ['title' => '', 'description' => 'Primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '40'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => '标题'], 'UpdateTime' => ['title' => '', 'description' => 'Update time.', 'type' => 'string', 'example' => '修改时间'], 'UpdateUser' => ['title' => '', 'description' => 'Modifier.', 'type' => 'string', 'example' => '修改用户'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request is successful. true: successful, false: failed.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Retrieve the Custom Text List', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListCustomViewPoints' => [ 'summary' => 'Lists custom viewpoints.', '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' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The topic of the hot list.', 'type' => 'string', 'example' => '热榜主题', 'required' => false], ], [ 'name' => 'Attitude', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The viewpoint to filter by.', 'type' => 'string', 'example' => '观点', 'required' => false], ], [ 'name' => 'Attitudes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of viewpoints to filter by.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A viewpoint.', 'type' => 'string', 'example' => '观点'."\n" .' * ', 'required' => false], 'required' => false, 'example' => '观点'."\n" .' * ', ], ], [ 'name' => 'CustomViewPointId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the custom viewpoint.', 'type' => 'string', 'example' => '461591f4880747f890702c1b90494d1a', 'required' => false], ], [ 'name' => 'CustomViewPointIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of custom viewpoint IDs.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A custom viewpoint ID.', 'type' => 'string', 'example' => 'bb1a5426a9c34e3e8165e7939032bddd', 'required' => false], 'required' => false, 'example' => '7ece3d1212e04c9ca716ae2486228f3f', ], ], [ 'name' => 'TopicId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The topic ID.', 'type' => 'string', 'example' => '1d20ed14db0840efb1c7eaaf4d46352b', 'required' => false], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '52', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'AsyncTaskId' => ['title' => '', 'description' => 'The ID of the asynchronous task that analyzes the custom viewpoint.', 'type' => 'string', 'example' => '2323ac73e174428a98c91097a59c67e0'], 'Attitude' => ['title' => '', 'description' => 'The viewpoint.', 'type' => 'string', 'example' => '观点'], 'CreateTime' => ['title' => '', 'description' => 'The time when the viewpoint was created.', 'type' => 'string', 'example' => '2024-08-15 16:18:59'], 'CreateUser' => ['title' => '', 'description' => 'The ID of the user who created the viewpoint.', 'type' => 'string', 'example' => '1'], 'Id' => ['title' => '', 'description' => 'The ID of the custom viewpoint.', 'type' => 'string', 'example' => '709806dd051042d5ab9de8bdbb3a64ca'], 'Status' => [ 'title' => '', 'description' => 'The task execution status. Valid values: PENDING, RUNNING, SUCCEEDED, SUSPENDED, FAILED, and CANCELED.', 'type' => 'string', 'example' => 'RUNNING', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], ], 'TaskErrorMessage' => ['title' => '', 'description' => 'The error message for the task execution.', 'type' => 'string', 'example' => '参数校验失败'], 'TaskStatus' => ['title' => '', 'description' => 'The task execution status. 0: PENDING, 1: RUNNING, 2: SUCCEEDED, 3: PAUSED, 4: FAILED (retriable), 5: FAILED (non-retriable), 6: CANCELED.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'ViewPoints' => [ 'description' => 'A list of topic selection viewpoints.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'The outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'The summary of the outline.', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['title' => '', 'description' => 'The generated viewpoint.', 'type' => 'string', 'example' => '视角'], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['title' => '', 'description' => 'The maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['title' => '', 'description' => 'The token for the next page of results.', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\`: The request was successful. \\`false\\`: The request failed.', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '73'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve Custom Viewpoint List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListCustomViewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListDataPermissions' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspaceId](~~2587495~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xx'], ], [ 'name' => 'DataType', 'in' => 'formData', 'schema' => ['description' => 'The data type.'."\n" ."\n" .'- dataset: a dataset', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'dataset'], ], [ 'name' => 'DataId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the data.'."\n" ."\n" .'- Example for a dataset: SystemSearch.QuarkCommonNews', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'SystemSearch.QuarkCommonNews'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['description' => 'The number of entries on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'title' => '', 'format' => 'int64', 'example' => '1'], 'CreateUser' => ['description' => 'The creator.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-12 21:46:24', 'title' => ''], 'UserId' => ['description' => 'The unique ID of the user with the permission.', 'type' => 'string', 'title' => '', 'example' => 'CustomSemanticSearch'], 'Username' => ['description' => 'The name of the user with the permission.', 'type' => 'string', 'title' => '', 'example' => 'xxx'], 'DataType' => ['description' => 'The data type.'."\n" ."\n" .'- dataset: a dataset', 'type' => 'string', 'title' => '', 'example' => 'xxx'], 'DataId' => ['description' => 'The unique ID of the data.'."\n" ."\n" .'- Example for a dataset: SystemSearch.QuarkCommonNews', 'type' => 'string', 'example' => 'SystemSearch.QuarkCommonNews'."\n", 'title' => ''], 'Permission' => ['description' => 'The permission type. The default value is \\`read\\`, which means read-only.', 'type' => 'string', 'example' => 'read', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'PageSize' => ['description' => 'The number of entries on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'title' => '', 'description' => 'The response.', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListDataPermissions', 'summary' => 'Permission to list datasets', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDataPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'translator' => 'machine', ], 'ListDatasetDocuments' => [ 'summary' => 'Lists data source documents.', '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' => '', 'description' => 'The unique ID of the Model Studio workspace. For more information, see [Get workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The search query.', 'type' => 'string', 'example' => '搜索条件', 'required' => false], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the dataset. You must specify either this parameter or `DatasetName`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the dataset.', 'type' => 'string', 'example' => '数据集名称', 'required' => false], ], [ 'name' => 'Status', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The status of the document. Valid values:'."\n" ."\n" .'- `1`: Document created.'."\n" ."\n" .'- `2`: Text index built.'."\n" ."\n" .'- `3`: Multimodal index built.'."\n" ."\n" .'- `100`: Full build complete.'."\n" ."\n" .'- `0`: Build failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'required' => false], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The type of the document. Valid values:'."\n" ."\n" .'- `plainText`: Plain text.'."\n" ."\n" .'- `richText`: Rich text.'."\n" ."\n" .'- `text`: A text file.'."\n" ."\n" .'- `pdf`: A PDF file.'."\n" ."\n" .'- `word`: A Word file.'."\n" ."\n" .'- `image`: An image file.'."\n" ."\n" .'- `video`: A video file.', 'type' => 'string', 'example' => 'text', 'required' => false], ], [ 'name' => 'DatasetDescription', 'in' => 'formData', 'schema' => ['description' => 'Deprecated.', 'type' => 'string', 'example' => 'xx', 'required' => false, 'title' => ''], ], [ 'name' => 'IncludeFields', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The fields to include in the response.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The field to include. Valid values:'."\n" ."\n" .'- `content`: The document content.'."\n" ."\n" .'- `chunks`: The document\'s chunks.', 'type' => 'string', 'required' => false, 'example' => 'content', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'ExcludeFields', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The fields to exclude from the response. Valid value:'."\n" ."\n" .'- `content`: The document content.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The field to exclude.', 'type' => 'string', 'required' => false, 'example' => 'content', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '10', 'required' => false], ], [ 'name' => 'CategoryUuids', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The unique IDs of the categories.', 'type' => 'array', 'items' => ['description' => 'The unique ID of the category.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Tags', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The tags.', 'type' => 'array', 'items' => ['description' => 'The tag.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Extend1', 'in' => 'formData', 'schema' => ['description' => 'A custom extension field.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'Extend2', 'in' => 'formData', 'schema' => ['description' => 'A custom extension field.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'Extend3', 'in' => 'formData', 'schema' => ['description' => 'A custom extension field.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['description' => 'The start of the creation time range, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end of the creation time range, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], ], [ 'name' => 'DocUuids', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The unique IDs of the documents.', 'type' => 'array', 'items' => ['description' => 'The unique ID of the document.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'DocIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'An array of document IDs.', 'type' => 'array', 'items' => ['description' => 'The document ID.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['description' => 'The start time, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['description' => 'The end time, specified as a Unix timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1111', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'The title.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'A token to retrieve the next page of results. This parameter is required when you retrieve more than 10,000 entries.', 'type' => 'string', 'example' => 'xxx', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'A list of documents.', 'type' => 'array', 'items' => [ 'description' => 'A document object.', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'The unique internal document ID.', 'type' => 'string', 'example' => '内部文档唯一ID'], 'Url' => ['title' => '', 'description' => 'The URL of the document.', 'type' => 'string', 'example' => 'https://xxx/xx'], 'Content' => ['title' => '', 'description' => 'The content of the document.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'The summary of the document.', 'type' => 'string', 'example' => 'xx'], 'Title' => ['title' => '', 'description' => 'The title of the document.', 'type' => 'string', 'example' => 'xx'], 'PubTime' => ['title' => '', 'description' => 'The publication time of the document.', 'type' => 'string', 'example' => '2022-01-01 00:00:00'], 'SourceFrom' => ['title' => '', 'description' => 'The source of the document.', 'type' => 'string', 'example' => '来源'], 'DisableHandleMultimodalMedia' => ['title' => '', 'description' => 'Indicates whether multimodal indexing is disabled for this document.', 'type' => 'boolean', 'example' => 'false'], 'MultimodalMedias' => [ 'description' => 'A list of multimodal media items associated with the document.', 'type' => 'array', 'items' => [ 'description' => 'A multimodal media object.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique ID of the multimodal media.', 'type' => 'string', 'example' => '多模态数据唯一标识'], 'MediaType' => ['title' => '', 'description' => 'The type of the multimodal media.', 'type' => 'string', 'example' => '多模态数据类型'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the image or video file.', 'type' => 'string', 'example' => '图片或视频文件地址'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DocId' => ['title' => '', 'description' => 'The user-specified unique document ID.', 'type' => 'string', 'example' => 'xx'], 'DocType' => ['title' => '', 'description' => 'The type of the document.', 'type' => 'string', 'example' => 'text'], 'Status' => ['title' => '', 'description' => 'The build status of the document index.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'CategoryUuid' => ['title' => '', 'description' => 'The unique ID of the category.', 'type' => 'string', 'example' => 'xx'], 'Extend1' => ['title' => '', 'description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx'], 'Extend2' => ['title' => '', 'description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx'], 'Extend3' => ['title' => '', 'description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx'], 'CreateTime' => ['title' => '', 'description' => 'The creation time of the document.', 'type' => 'string', 'example' => '2025-04-14 19:59:53'], 'UpdateTime' => ['title' => '', 'description' => 'The last update time of the document.', 'type' => 'string', 'example' => '2025-04-14 19:59:53'], 'UpdateUser' => ['description' => 'The user who last updated the document.', 'type' => 'string', 'example' => '1', 'title' => ''], 'CreateUser' => ['description' => 'The creator of the document.', 'type' => 'string', 'example' => '1', 'title' => ''], 'Tags' => [ 'description' => 'A list of tags associated with the document.', 'type' => 'array', 'items' => ['description' => 'A tag.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['title' => '', 'description' => 'The total number of matching documents.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code for the request.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'A detailed message about the request status.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'NextToken' => ['description' => 'The token used to retrieve the next page of results. This field appears only when more results are available.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Data Source - Document List ', 'changeSet' => [ ['createdAt' => '2025-05-08T11:57:21.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDatasetDocuments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListDatasets' => [ 'summary' => 'Data source management - query', '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' => '', 'description' => 'The unique ID of the Model Studio workspace. For more information, see [Get workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The start of the creation time range.', 'type' => 'string', 'example' => '创建时间-开始', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The end of the creation time range.', 'type' => 'string', 'example' => '创建时间-结束', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The dataset name. The name must be globally unique.', 'type' => 'string', 'example' => 'businessDataset', 'required' => false], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'DatasetType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The dataset type.', 'type' => 'string', 'example' => 'CustomSemanticSearch', 'required' => false], ], [ 'name' => 'SearchDatasetEnable', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies the dataset search setting.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'required' => false], ], [ 'name' => 'IncludeConfig', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to return configuration and usage information. Default value: false.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => ''], ], [ 'name' => 'DatasetDescription', 'in' => 'formData', 'schema' => ['description' => 'A keyword within the dataset description to filter results.', 'type' => 'string', 'example' => 'xx', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'An array of dataset objects.', 'type' => 'array', 'items' => [ 'description' => 'A dataset object.', 'type' => 'object', 'properties' => [ 'DatasetId' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'CreateUser' => ['title' => '', 'description' => 'The creator of the dataset.', 'type' => 'string', 'example' => 'xxx'], 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-12 21:46:24'], 'DatasetType' => ['title' => '', 'description' => 'The dataset type.', 'type' => 'string', 'example' => 'CustomSemanticSearch'], 'DatasetName' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'xxx'], 'DatasetDescription' => ['title' => '', 'description' => 'The dataset description.', 'type' => 'string', 'example' => 'xxx'], 'SearchDatasetEnable' => ['title' => '', 'description' => 'Indicates whether search is enabled for the dataset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'DocUsedQuota' => ['title' => '', 'description' => 'The number of documents uploaded to the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'AccessLevel' => ['description' => 'The dataset access level.', 'type' => 'string', 'example' => 'private', 'title' => ''], 'Administrators' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Username' => ['description' => 'The administrator username.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'UserId' => ['description' => 'The administrator user ID.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'description' => 'An administrator object.', 'title' => '', 'example' => '', ], 'description' => 'The administrators of the dataset.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values: `true` (success) and `false` (failure).', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The response message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'TotalCount' => ['title' => '', 'description' => 'The total number of datasets.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'CustomSemanticSearchConfig' => [ 'description' => 'Configuration and usage details for custom semantic search datasets that use uploaded files as data sources.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocQuota' => ['title' => '', 'description' => 'The document quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'], 'DocUsedQuota' => ['title' => '', 'description' => 'The used document quota.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'DatasetQuota' => ['title' => '', 'description' => 'The dataset quota.', 'type' => 'integer', 'format' => 'int32', 'example' => '3'], 'DatasetUsedQuota' => ['title' => '', 'description' => 'The number of datasets created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'ThirdSearchConfig' => [ 'description' => 'Configuration and usage details for API-integrated datasets.', 'title' => '', 'type' => 'object', 'properties' => [ 'DatasetQuota' => ['title' => '', 'description' => 'The dataset quota.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'DatasetUsedQuota' => ['title' => '', 'description' => 'The number of datasets created.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Data Source - List', 'changeSet' => [ ['createdAt' => '2025-05-08T11:59:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDatasets', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListDialogues' => [ 'summary' => 'History of online inference scenarios.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for the task.'."\n" ."\n" .'> You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId in later tasks, those tasks belong to the same conversation group.', 'type' => 'string', 'example' => 'xxx', 'maxLength' => 64, 'minLength' => 6, 'required' => false], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Start time.', 'type' => 'string', 'example' => '2024-01-04 11:46:07', 'required' => false], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'End time.', 'type' => 'string', 'example' => '2024-01-04 11:46:07', 'required' => false], ], [ 'name' => 'DialogueType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Generation type. Valid values: 1 (creation) and 2 (intelligent search). Default value: 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'default' => '2', 'enum' => ['1', '2'], 'required' => false, ], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Number of items per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'successful'], 'Current' => ['description' => 'Page number of the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'List of generation history records.', 'type' => 'array', 'items' => [ 'description' => 'Generation history record.', 'type' => 'object', 'properties' => [ 'Bot' => ['title' => '', 'description' => 'Model output.', 'type' => 'string', 'example' => 'xx'], 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2024-01-04 11:46:07'], 'CreateUser' => ['title' => '', 'description' => 'Creator.', 'type' => 'string', 'example' => 'xx'], 'DialogueType' => ['title' => '', 'description' => 'Generation type. Valid values: 1 (creation) and 2 (intelligent search). Default value: 2.', 'type' => 'integer', 'format' => 'int32', 'example' => '2'], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => 'xx'], 'User' => ['title' => '', 'description' => 'User input.', 'type' => 'string', 'example' => 'x'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'Unique identifier for the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Size' => ['description' => 'Number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Generation History List', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListDialogues'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDialogues', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListDocs' => [ 'summary' => 'Miàodú retrieves the list of documents.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Alibaba Cloud Model Studio workspace ID. For more information, see [How to Use Workspaces](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'DocName', 'in' => 'formData', 'schema' => ['description' => 'Document name.', 'type' => 'string', 'required' => false, 'example' => '企业2022年報', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => ['description' => 'Document type.', 'type' => 'string', 'required' => false, 'example' => 'pdf', 'title' => ''], ], [ 'name' => 'Skip', 'in' => 'formData', 'schema' => ['description' => 'Skip n records for paging.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Next page token.', 'type' => 'string', 'required' => false, 'example' => '52a33dc83779f63641e16f5146cd7125', 'title' => ''], ], [ 'name' => 'Statuses', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Document status list.', 'type' => 'array', 'items' => ['description' => 'Status value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'Document folder.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Return code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'List of returned data results.', 'type' => 'array', 'items' => [ 'description' => 'Paging data.', 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'Creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '2024-01-04 11:46:07', 'title' => ''], 'DocId' => ['description' => 'Document ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], 'DocName' => ['description' => 'Document name.', 'type' => 'string', 'example' => '标题093', 'title' => ''], 'DocType' => ['description' => 'Document type.', 'type' => 'string', 'example' => 'pdf', 'title' => ''], 'Status' => ['description' => 'Status.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], 'StatusMessage' => ['description' => 'Status message.', 'type' => 'string', 'example' => '导入完成', 'title' => ''], 'CategoryId' => ['description' => 'Document folder.', 'type' => 'string', 'example' => 'default', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'MaxResults' => ['description' => 'Maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Message' => ['description' => 'Return message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'NextToken' => ['description' => 'Next page token.', 'type' => 'string', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4mYAAAAACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '70', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'List Documents', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDocs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'ListDocumentRetrieve' => [ 'summary' => 'Searches government document libraries based on complex conditions.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Model Studio workspace. For more information, see [Get workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-'], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '94', 'required' => false], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Token for the next page of results.', 'type' => 'string', 'example' => 'cEoBWREAXdxaOyjq/cqAbg==', 'required' => false], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Search condition.', 'type' => 'string', 'example' => '检索Query', 'required' => false], ], [ 'name' => 'ContentType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Document type. Valid values: 0 (default): All types. 1: Government documents. 2: Important articles. 5: Policy interpretation. 6: Legal provisions. 7: Regulations and rules. 8: General Secretary.', 'type' => 'string', 'example' => '1', 'required' => false], ], [ 'name' => 'SubContentType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '- Secondary classification of document type.'."\n" ."\n" .' - When the document type is an official document: -1: Other; 0: Resolution; 1: Decision; 2: Order; 3: Bulletin; 4: Public Notice; 5: Notice; 6: Opinion; 7: Notification; 8: Circular; 9: Report; 10: Request for Instructions; 11: Approval; 12: Motion; 13: Letter'."\n" ."\n" .' - 14: Summary'."\n" ."\n" .' - When the article type is important articles: 1: important commentary 2: important theory 3: other articles'."\n" ."\n" .' - When the document genre is rules and regulations: 3: Administrative regulations 4: Supervisory regulations 5: Local regulations 7: Departmental rules 8: Others 9: Party constitution and regulations'."\n" ."\n" .' - When the article genre is a legal provision: 1: Constitution 2: Law 6: Judicial Interpretation', 'type' => 'string', 'example' => '1', 'required' => false], ], [ 'name' => 'Region', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Region. Enter a province or city, such as Jilin Province or Beijing Municipality.', 'type' => 'string', 'example' => '北京市', 'required' => false], ], [ 'name' => 'Source', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Source. Valid values: 0: Internal (within your organization). 1: External (outside your organization).', 'type' => 'string', 'example' => '1', 'required' => false], ], [ 'name' => 'StartDate', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Start date of issuance in yyyy-MM-dd format.', 'type' => 'string', 'example' => '2025-10-10', 'required' => false], ], [ 'name' => 'EndDate', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'End date of issuance in yyyy-MM-dd format.', 'type' => 'string', 'example' => '2025-07-03', 'required' => false], ], [ 'name' => 'Office', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Issuing agency.', 'type' => 'string', 'example' => '国务院办公室', 'required' => false], ], [ 'name' => 'WordSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Document number.', 'type' => 'string', 'example' => '宁民规〔2020〕5号', 'required' => false], ], [ 'name' => 'ElementScope', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Search scope. Valid values: 1: Title only. 0: Full text (title and content). Default is 0.', 'type' => 'string', 'example' => '0', 'required' => false], ], [ 'name' => 'SubjectClassify', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Supported classifications:'."\n" ."\n" .'| Level 1 category | Level 2 category |'."\n" .'| ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| National defense and international cooperation | National defense. Foreign affairs. Military affairs. Work related to Hong Kong, Macao, Taiwan, and overseas Chinese. |'."\n" .'| Comprehensive administration | The 20th National Congress of the Communist Party of China. Government transparency and supervision. Joint administration. Party building. Conferences and proposals. Government document management. Other administrative matters. |'."\n" .'| State Council organizational structure | State Council. General Office of the State Council. State Council agencies. |'."\n" .'| Administrative and market regulation | Administrative regulation. Credit regulation. Product quality supervision. Work safety supervision. Market regulation. |'."\n" .'| Economic management | National economy. Market economy. Economic system reform. State-owned asset supervision. |'."\n" .'| Finance, banking, commerce, and customs | Finance. Banking. Auditing. Commerce. Customs. |'."\n" .'| Personnel and social security | Personnel work. Population and family planning. Work related to women and children. Poverty alleviation. Disaster reduction and relief. Public services. Social welfare and assistance. Preferential treatment and resettlement. Social security. |'."\n" .'| Public security and social management | Public security. Safety. Justice. Fire control. Ethnic affairs. Religion. |'."\n" .'| Science, education, culture, and sports | Culture. Scientific and technological innovation. Education. Intellectual property. Press and publishing. Radio, television, and the Internet. Sports. Tourism. |'."\n" .'| Healthcare | Health. Medical care. Veterinary medicine. |'."\n" .'| Urban-rural development and industrial growth | Urban and rural development. Industry. Transportation. |'."\n" .'| Natural resources and environmental protection | Land and energy resources. Civil engineering. Meteorology. Environmental protection. |'."\n" .'| Agriculture, forestry, water resources, fisheries, and animal husbandry | Agriculture. Forestry. Water resources. Fisheries. Animal husbandry. |'."\n" .'| Others | Others. |', 'type' => 'string', 'example' => '国防和交流合作事务', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => '文章标题'], 'Essay' => ['title' => '', 'description' => 'Main text.', 'type' => 'string', 'example' => '文章正文'], 'Link' => ['title' => '', 'description' => 'URL.', 'type' => 'string', 'example' => '文章链接'], 'IssuingAuthority' => ['title' => '', 'description' => 'Issuing agency.', 'type' => 'string', 'example' => '发布机构'], 'PublicationDate' => ['title' => '', 'description' => 'Publication date.', 'type' => 'string', 'example' => '2023-02-01'], ], 'example' => '', ], 'example' => 'data', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['title' => '', 'description' => 'Maximum number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '71'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['title' => '', 'description' => 'Token for the next page.', 'type' => 'string', 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='], 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Official Document Repository Search ', 'description' => 'The Quanmiao product supports iframe embedding. For more information, see [Customer Integration: Quanmiao Public Cloud iframe Customization Plan](~~3000990~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDocumentRetrieve', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'ListEnterprisePptTemplates' => [ 'summary' => 'Lists the enterprise-specific PPT templates.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-xx'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token for the next page of results. Note: This parameter is not yet in effect.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'XXXX'], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per page. Note: This parameter is not yet in effect.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '10', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => 'null'], ], [ 'name' => 'Skip', 'in' => 'query', 'schema' => ['description' => 'The number of entries to skip (the \'offset\'). Note: This parameter is not yet in effect.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '10', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Current' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The ID of the template.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'CoverImg' => ['description' => 'The URL of the cover image.', 'type' => 'string', 'example' => 'http://xxx.com/a.png', 'title' => ''], ], 'description' => 'An object that contains the details of a template.', 'title' => '', 'example' => '', ], 'description' => 'An array of enterprise-specific PPT template objects.', 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The unique request ID. Provide this ID when you contact technical support.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Size' => ['description' => 'The number of entries returned on the current page (the \'page size\').', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request succeeded. `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TotalCount' => ['description' => 'The total number of entries that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NextToken' => ['description' => 'The token for the next page of results. An empty value indicates that no more data is available. Note: This parameter is not yet in effect.', 'type' => 'string', 'title' => '', 'example' => 'CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4AACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc='], 'MaxResults' => ['description' => 'The maximum number of results per page, as specified in the request. Note: This parameter is not yet in effect.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '4'], ], 'title' => '', 'description' => 'The response body.', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListEnterprisePptTemplates', 'description' => 'Quanmiao supports iframe integration. For details, see the [Quanmiao Public Cloud iframe Customization Guide](~~3000990~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListEnterprisePptTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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 \\"TotalCount\\": 100,\\n \\"NextToken\\": \\"CAESGgoSChAKDGNvbXBsZXRlVGltZRABCgQiAggAGAAiQAoJANEQ4AACjMDLgAAADFTNzMyZDMwMzAzMDM4NzA3MjZjN2E2NDYyNzUzODMxMzY3ODM0NmIzNTZkNjc=\\",\\n \\"MaxResults\\": 4\\n}","type":"json"}]', 'translator' => 'machine', ], 'ListFreshViewPoints' => [ 'summary' => 'List of novel perspectives.', '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' => ['description' => 'UUID of the workspace: AgentKey ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['description' => 'Trending list source ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜源'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['description' => 'Trending list topic ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜主题'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Token for the next page ', 'title' => '', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of returned results ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '6', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code ', 'title' => '', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business Data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'Outlines', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outline' => ['description' => 'Outline ', 'title' => '', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['description' => 'Outline summary ', 'title' => '', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['description' => 'Generated perspective ', 'title' => '', 'type' => 'string', 'example' => '视角'], 'Summary' => ['description' => 'Summary', 'title' => '', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['description' => 'Maximum number of return results', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '94'], 'Message' => ['description' => 'Fault description', 'title' => '', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['description' => 'Token for the next page', 'title' => '', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['description' => 'Request UUID', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded: true for success, false for failure ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['description' => 'Total count', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '26'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve a list of novel perspectives ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListFreshViewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListGeneralConfigs' => [ 'summary' => 'Lists the general configurations.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Model Studio workspace. For more information, see [Get a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The current page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The query results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The query results.', 'title' => '', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['title' => '', 'description' => 'The unique identifier of the configuration item.', 'type' => 'string', 'example' => 'xxx'], 'ConfigValue' => ['title' => '', 'description' => 'The value of the configuration item.', 'type' => 'string', 'example' => 'xxx'], 'ConfigValueType' => ['title' => '', 'description' => 'The type of the configuration item.', 'type' => 'string', 'example' => 'CustomSemanticSearch'], 'ConfigDesc' => ['title' => '', 'description' => 'The description of the configuration item.', 'type' => 'string', 'example' => 'xxx'], ], 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The fault description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'PageSize' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Common Configuration - List ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListGeneralConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListGeneratedContents' => [ 'summary' => 'Retrieve a list of documents: Query the history of articles created in MiaoBi.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Workspace ID: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Task ID'."\n" ."\n" .'> You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId for multiple tasks, those tasks belong to the same conversation.', 'type' => 'string', 'required' => false, 'example' => 'task-03d46184ee7d8749'], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['description' => 'Start time', 'type' => 'string', 'required' => false, 'example' => '2024-01-04 11:46:07', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['description' => 'End time', 'type' => 'string', 'required' => false, 'example' => '2024-01-04 11:46:07', 'title' => ''], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Title text', 'type' => 'string', 'required' => false, 'example' => '杭州亚运会'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Search keyword: Supports fuzzy search on titles and content', 'type' => 'string', 'required' => false, 'example' => '检索Query'], ], [ 'name' => 'ContentDomain', 'in' => 'formData', 'schema' => [ 'description' => 'Content domain (content category)'."\n" ."\n" .'- media: Media writing'."\n" ."\n" .'- government: Government document writing'."\n" ."\n" .'- office: Office writing'."\n" ."\n" .'- market: Marketing writing'."\n" ."\n" .'- custom: Custom writing'."\n" ."\n" .'- commentGenerate: Opinion generation', 'enumValueTitles' => ['market' => 'Marketing writing', 'government' => 'Government', 'custom' => 'Custom writing', 'media' => 'Media', 'office' => 'Office writing', 'commentGenerate' => 'Opinion generation'], 'type' => 'string', 'example' => 'media', 'default' => 'media', 'enum' => [], 'required' => false, 'title' => '', ], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'DataType', 'in' => 'formData', 'schema' => ['description' => 'Data type filter'."\n" ."\n" .'- plainText: Plain text'."\n" ."\n" .'- richText: Rich text'."\n" ."\n" .'- html: HTML'."\n" ."\n" .'- pdf: PDF'."\n" ."\n" .'- word: Word'."\n" ."\n" .'- excel: Excel'."\n" ."\n" .'- csv: CSV'."\n" ."\n" .'- image: Image'."\n" ."\n" .'- video: Video'."\n" ."\n" .'- audio: Audio', 'type' => 'string', 'required' => false, 'example' => 'plainText', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Current' => ['description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'Document list', 'type' => 'array', 'items' => [ 'description' => 'Document', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'Content: rich text', 'type' => 'string', 'example' => '杭州亚运会'], 'ContentDomain' => ['title' => '', 'description' => 'Content domain (content category)'."\n" ."\n" .'- media: Media writing'."\n" ."\n" .'- government: Government document writing'."\n" ."\n" .'- office: Office writing'."\n" ."\n" .'- market: Marketing writing'."\n" ."\n" .'- custom: Custom writing'."\n" ."\n" .'- commentGenerate: Opinion generation', 'type' => 'string', 'example' => 'media'], 'ContentText' => ['title' => '', 'description' => 'Content: plain text', 'type' => 'string', 'example' => '杭州亚运会'], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2024-01-04 11:46:07'], 'CreateUser' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '"123"'], 'DeviceId' => ['title' => '', 'description' => 'Device ID', 'type' => 'string', 'example' => 'xxx'], 'Id' => ['title' => '', 'description' => 'Document ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'KeywordList' => [ 'description' => 'Keywords', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Keyword', 'type' => 'string', 'example' => '观点', 'title' => ''], 'example' => '', ], 'Keywords' => ['title' => '', 'description' => 'Keywords (string)', 'type' => 'string', 'example' => '观点'], 'Prompt' => ['title' => '', 'description' => 'Last prompt used to generate this document', 'type' => 'string', 'example' => '创作xxx文章'], 'TaskId' => ['title' => '', 'description' => 'Conversation task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '杭州亚运会'], 'UpdateTime' => ['title' => '', 'description' => 'Update time', 'type' => 'string', 'example' => '2024-01-04 11:46:07'], 'UpdateUser' => ['title' => '', 'description' => 'Updater', 'type' => 'string', 'example' => '"1111"'], 'Uuid' => ['title' => '', 'description' => 'UUID traceability ID', 'type' => 'string', 'example' => 'xxx'], 'FileKey' => ['description' => 'File ID', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx', 'title' => ''], 'FileAttr' => [ 'description' => 'File attributes', 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'File name', 'type' => 'string', 'example' => 'homedepothp.txt', 'title' => ''], 'Width' => ['description' => 'Video width', 'type' => 'integer', 'format' => 'int32', 'example' => '800', 'title' => ''], 'TmpUrl' => ['description' => 'Temporary URL for video file access. Expires in one hour.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.mp4', 'title' => ''], 'Height' => ['description' => 'Video height', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Size' => ['description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['title' => '', 'description' => 'Operation status: true means success. false means failure.', 'type' => 'boolean', 'example' => 'true'], 'Total' => ['description' => 'Total number of items', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve document list ', 'changeSet' => [ ['createdAt' => '2025-05-12T06:20:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-09-18T03:28:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-09-18T03:28:07.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-31T03:59:14.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListHotNewsWithType' => [ 'summary' => 'Retrieves the list of trending topic hotspots.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the business space: [AgentKey](~~3027170~~).', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'NewsType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The news category. Valid values:'."\n" .'- society: social current affairs.'."\n" .'- person: people news.'."\n" .'- government: government affairs.', 'type' => 'string', 'example' => 'society', 'enum' => ['society', 'person', 'government'], 'required' => false, ], ], [ 'name' => 'NewsTypes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The list of news categories for multi-selection. Valid values:'."\n" .'- society: social current affairs.'."\n" .'- person: people news.'."\n" .'- government: government affairs.', 'type' => 'array', 'items' => ['description' => 'The news category.', 'type' => 'string', 'required' => false, 'example' => 'society', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false, 'title' => ''], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult>', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'title' => '', 'description' => 'The business data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'News' => [ 'title' => '', 'description' => 'The news list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者名称'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '新闻内容'], 'DocUuid' => ['title' => '', 'description' => 'The unique identifier of the internal document.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'ImageUrls' => [ 'title' => '', 'description' => 'The image URLs.', 'type' => 'array', 'items' => ['description' => 'The URL of the news image.', 'type' => 'string', 'example' => 'http://www.example.com/a.jpg', 'title' => ''], 'example' => '', ], 'PubTime' => ['title' => '', 'description' => 'The publish time.', 'type' => 'string', 'example' => '2023-04-11 06:14:07'], 'SearchSource' => ['title' => '', 'description' => 'The search source.', 'type' => 'string', 'example' => '新浪热榜'], 'SearchSourceName' => ['title' => '', 'description' => 'The search source name.', 'type' => 'string', 'example' => '新浪热榜'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '新浪新闻综合'], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '摘要'], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '社会'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '新闻标题'], 'UpdateTime' => ['title' => '', 'description' => 'The system update time.', 'type' => 'string', 'example' => '2023-10-14 14:30:00'], 'Url' => ['title' => '', 'description' => 'The article URL.', 'type' => 'string', 'example' => 'http://www.example.com/a.html'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'NewsType' => ['title' => '', 'description' => 'The news category. Valid values:'."\n" .'- society: social current affairs.'."\n" .'- person: people news.'."\n" .'- government: government affairs.', 'type' => 'string', 'example' => 'society'], 'NewsTypeName' => ['title' => '', 'description' => 'The news category name.', 'type' => 'string', 'example' => '社会时事'], 'TotalPages' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '77'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. Valid values:'."\n" .'- true: The request was successful.'."\n" .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], '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' => 'Retrieve trending topic hotspot list', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], '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' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], ], 'ListHotSources' => [ 'summary' => 'Retrieve the list of hot ranking sources for all platforms. ', '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' => ['description' => 'UUID of the workspace: AgentKey ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Token for the next page ', 'title' => '', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of returned results ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '66', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2 ', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code ', 'title' => '', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Third-party source list ', 'type' => 'array', 'items' => [ 'description' => 'Third-party source object ', 'type' => 'object', 'properties' => [ 'Description' => ['description' => 'Hot ranking source description ', 'title' => '', 'type' => 'string', 'example' => '热榜源描述'], 'Show' => ['description' => 'Whether to display in the console ', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Sort' => ['description' => 'Sorting value ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '86'], 'Source' => ['description' => 'Hot ranking source identity ', 'title' => '', 'type' => 'string', 'example' => '热榜源标识'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['description' => 'Maximum number of results returned ', 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], 'Message' => ['description' => 'Fault description ', 'title' => '', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['description' => 'Next page token ', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], 'RequestId' => ['description' => 'Request UUID ', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded: true for success, false for failure ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['description' => 'Total number of records ', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve the list of third-party trending sources ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListHotSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListHotTopics' => [ 'summary' => 'Retrieves a list of trending topics.', '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' => ['description' => 'The unique identifier of the business space.', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm', 'title' => ''], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['description' => 'Filters the results by hot topic source. For a list of supported hot topic sources, call the `ListHotSources` operation.'."\n" ."\n" .'`Aggregation`: represents the aggregated list of national hot topics.', 'type' => 'string', 'example' => 'Quark', 'title' => '', 'required' => false], ], [ 'name' => 'Topics', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Filters the results by hot topic.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The name of a hot topic.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxx'], 'required' => false, 'example' => '', ], ], [ 'name' => 'TopicVersion', 'in' => 'formData', 'schema' => ['description' => 'Filters the results by data version.', 'type' => 'string', 'example' => '数据版本筛选', 'title' => '', 'required' => false], ], [ 'name' => 'TopicQuery', 'in' => 'formData', 'schema' => ['description' => 'The keywords for a full-text search on hot topics.', 'type' => 'string', 'example' => '根据热榜主题全文检索', 'title' => '', 'required' => false], ], [ 'name' => 'TopicIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of topic IDs.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A topic ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xxxxxx'], 'required' => false, 'example' => '', ], ], [ 'name' => 'WithNews', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to include news in the response.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token used to retrieve the next page of results. If you do not specify this parameter, the service returns the first page of results. You can get this token from the `NextToken` response parameter of the previous request.', 'type' => 'string', 'example' => '下一页的token', 'title' => '', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of results to return for a single request. If this parameter is not specified, the service uses a default value.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'CustomField', 'in' => 'formData', 'schema' => ['description' => 'Filters the results by a custom business field. The service performs an exact keyword match on this field. The value can be up to 255 characters long.', 'type' => 'string', 'example' => 'biz-tag-001', 'maxLength' => 255, 'title' => '', 'required' => false], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['description' => 'The start of the creation time filter range (inclusive). The value must be in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-06-01 00:00:00', 'title' => '', 'required' => false], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end of the creation time filter range (inclusive). The value must be in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-06-04 23:59:59', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The paginated response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A list of hot topic objects.', 'type' => 'object', 'properties' => [ 'AsyncTaskId' => ['description' => 'The asynchronous task ID. This parameter is returned only when `TopicSource` is `Custom`.', 'type' => 'string', 'example' => '异步任务ID（自定义主题场景下使用）', 'title' => ''], 'CreateUser' => ['description' => 'The ID of the user who created the topic. This parameter is returned only when `TopicSource` is `Custom`.', 'type' => 'string', 'example' => '创建用户ID（自定义主题场景下使用）', 'title' => ''], 'HotValue' => ['description' => 'The popularity score of the topic.', 'type' => 'integer', 'format' => 'int64', 'example' => '61', 'title' => ''], 'Id' => ['description' => 'The ID of the hot topic.', 'type' => 'string', 'example' => '热榜ID', 'title' => ''], 'Status' => [ 'description' => 'The asynchronous task status. This parameter is returned only when `TopicSource` is `Custom`. Valid values: `PENDING`, `RUNNING`, `SUCCEEDED`, `SUSPENDED`, `FAILED`, and `CANCELED`.', 'type' => 'string', 'example' => 'FAILED', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'SUSPENDED', 'FAILED', 'CANCELED'], 'title' => '', ], 'StructureSummary' => [ 'description' => 'A list of structured topic summaries.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DocList' => [ 'description' => 'A list of articles used to generate the title and summary.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Source' => ['description' => 'The source of the article.', 'type' => 'string', 'example' => '夸克', 'title' => ''], 'Title' => ['description' => 'The article title.', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'Url' => ['description' => 'The article URL.', 'type' => 'string', 'example' => 'http://www.example.com', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Summary' => ['description' => 'The generated summary.', 'type' => 'string', 'example' => '摘要', 'title' => ''], 'Title' => ['description' => 'The generated title.', 'type' => 'string', 'example' => '标题', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Summary' => ['description' => 'The hot topic summary.', 'type' => 'string', 'example' => '热榜摘要', 'title' => ''], 'TaskErrorMessage' => ['description' => 'The error message returned when the asynchronous task fails.', 'type' => 'string', 'example' => '异步任务失败错误信息', 'title' => ''], 'TaskStatus' => ['description' => 'The asynchronous task status. This parameter is returned only when `TopicSource` is `Custom`. Valid values: `0` (Pending), `1` (Running), `2` (Succeeded), `3` (Suspended, not currently in use), `4` (Failed), and `6` (Canceled).', 'type' => 'integer', 'format' => 'int32', 'example' => '26', 'title' => ''], 'Topic' => ['description' => 'The unique topic name.', 'type' => 'string', 'example' => '主题唯一名称', 'title' => ''], 'TopicSource' => ['description' => 'The source of the hot topic. Valid values:'."\n" ."\n" .'- `Toutiao`'."\n" ."\n" .'- `Quark`'."\n" ."\n" .'- `Baidu`'."\n" ."\n" .'- `Sina`'."\n" ."\n" .'- `Custom`'."\n" ."\n" .'- `Aggregation`', 'type' => 'string', 'example' => 'Toutiao', 'title' => ''], 'Version' => ['description' => 'The data version.', 'type' => 'string', 'example' => '数据版本', 'title' => ''], 'CustomField' => ['description' => 'A custom field for business-specific data, such as a keyword.', 'type' => 'string', 'example' => 'biz-tag-001', 'title' => ''], 'CreateTime' => ['description' => 'The time the topic was created, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2026-06-04 12:34:56', 'title' => ''], 'TopicUrl' => ['description' => 'The URL of the original topic.', 'type' => 'string', 'example' => 'https://www.example.com/topic/123', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of results returned on this page.', 'type' => 'integer', 'format' => 'int32', 'example' => '94', 'title' => ''], 'Message' => ['description' => 'The result message for the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'NextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => '下一页的token', 'title' => ''], 'RequestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success; `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'TotalCount' => ['description' => 'The total number of topics found.', 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''], ], 'example' => '', ], ], ], '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 \\"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"}]', 'title' => 'Retrieve hot spot topic list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListHotTopics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListHotViewPoints' => [ 'summary' => 'List of popular viewpoints. ', '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' => ['description' => 'UUID of the workspace: AgentKey', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['description' => 'Hotlist source', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜源'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['description' => 'Hot topic subject', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜主题'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Token for the next page', 'title' => '', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of returned results', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '56', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2 ', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code', 'title' => '', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business Data ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Viewpoint object ', 'type' => 'object', 'properties' => [ 'Attitude' => ['description' => 'Current viewpoint', 'title' => '', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['description' => 'Attitude Type ', 'title' => '', 'type' => 'string', 'example' => '观点类型'], 'News' => [ 'description' => 'List of related news articles ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Article object ', 'type' => 'object', 'properties' => [ 'Author' => ['description' => 'Author ', 'title' => '', 'type' => 'string', 'example' => '作者'], 'Content' => ['description' => 'Content ', 'title' => '', 'type' => 'string', 'example' => '文章内容'], 'DocId' => ['description' => 'External UUID of the article ', 'type' => 'string', 'example' => 'xxxxx', 'title' => ''], 'DocUuid' => ['description' => 'Unique ID of the article', 'title' => '', 'type' => 'string', 'example' => '123456'], 'ImageUrls' => [ 'description' => 'URLs of article images ', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Image Link ', 'type' => 'string', 'example' => 'https://www.example.com/aaa.png', 'title' => ''], 'example' => 'https://www.example.com/aaa.png', ], 'PubTime' => ['description' => 'Published At. Format: YYYY-MM-dd HH:mm:ss', 'title' => '', 'type' => 'string', 'example' => '2024-01-22 10:29:00'], 'Source' => ['description' => 'Source', 'title' => '', 'type' => 'string', 'example' => '新浪'], 'Summary' => ['description' => 'summary', 'title' => '', 'type' => 'string', 'example' => '文章摘要'], 'Tags' => [ 'description' => 'tags', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Article tags', 'type' => 'string', 'example' => '["标签1","标签2"]', 'title' => ''], 'example' => '["标签1","标签2"]', ], 'Title' => ['description' => 'title', 'title' => '', 'type' => 'string', 'example' => '文章标题'], 'Topic' => ['description' => 'topic', 'title' => '', 'type' => 'string', 'example' => '文章主题'], 'Url' => ['description' => 'Article URL', 'title' => '', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Ratio' => ['description' => 'Current viewpoint ratio', 'title' => '', 'type' => 'string', 'example' => '当前观点占比'], 'ViewPoints' => [ 'description' => 'List of topic viewpoints ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'Outline', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Outline object', 'type' => 'object', 'properties' => [ 'Outline' => ['description' => 'Outline', 'title' => '', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['description' => 'Outline summary', 'title' => '', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['description' => 'Generated point', 'title' => '', 'type' => 'string', 'example' => '视角'], 'Summary' => ['description' => 'Summary ', 'title' => '', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['description' => 'Maximum number of return results ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '67'], 'Message' => ['description' => 'Fault description ', 'title' => '', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['description' => 'Token for the next page ', 'title' => '', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['description' => 'Request UUID ', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded: true for success, false for failure', 'title' => '', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['description' => 'Total count ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '70'], ], 'example' => '', ], ], ], '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"}]', 'title' => 'Retrieve Hot Perspectives List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListHotViewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListInterveneCnt' => [ 'summary' => 'Lists the number of intervention projects.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'fcb14f25c9ee41ccad33a049de8f941b_p_outbound_public'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ 'name' => 'PageIndex', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult\\', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'CntList' => [ 'description' => 'List of count information', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Count information by categorization', 'type' => 'any', 'example' => '{'."\n" .'"namespace":"namespace_qa_query", '."\n" .'"interfereType":0,'."\n" .'"cnt": 10'."\n" .'}', 'title' => ''], 'example' => '', ], 'PageCnt' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'PageIndex' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Code' => ['description' => 'Intervention service status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain the quantity of all intervention items', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListInterveneCnt', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListInterveneImportTasks' => [ 'summary' => 'Retrieve a list of import tasks.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'PageIndex', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'PageIndex' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'StatusList' => [ 'description' => 'Task status information', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Msg' => ['title' => '', 'description' => 'Task message', 'type' => 'string', 'example' => 'Success'], 'Percentage' => ['title' => '', 'description' => 'Completion percentage', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'Status' => ['title' => '', 'description' => 'Task status', 'type' => 'integer', 'format' => 'int32', 'example' => 'Success'], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '4854'], 'TaskName' => ['title' => '', 'description' => 'Task name', 'type' => 'string', 'example' => '12344454'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'TotalSize' => ['title' => '', 'description' => 'Total number of pages', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'Code' => ['description' => 'Status code returned by the intervention service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'List import jobs for intervention items', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [], 'translator' => 'machine', ], 'ListInterveneRules' => [ 'summary' => 'Retrieves a list of intervention rules.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'PageIndex', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'Count' => ['title' => '', 'description' => 'Number of items', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'InterveneRuleList' => [ 'description' => 'List of rules', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Rule description', 'type' => 'object', 'properties' => [ 'AnswerConfig' => [ 'description' => 'Answer configuration', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Answer configuration item', 'type' => 'object', 'properties' => [ 'AnswerType' => [ 'title' => '', 'description' => 'Answer type', 'enumValueTitles' => ['0-统一回复' => '0 - Unified response', '1-定向回复 ' => '1 - Targeted response'], 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'Message' => ['title' => '', 'description' => 'Answer content', 'type' => 'string', 'example' => '抱歉我无法回答'], 'Namespace' => ['title' => '', 'description' => 'Namespace', 'type' => 'string', 'example' => 'namespace_qa_query'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2023-06-05 15:17:01'], 'EffectTime' => ['title' => '', 'description' => 'Effective time', 'type' => 'string', 'example' => '2023-04-03 02:42:01'], 'InterveneType' => [ 'title' => '', 'description' => 'Intervention type', 'enumValueTitles' => ['0-永久生效' => '0 - Permanent', '1-按时间生效' => '1 - Time-based'], 'type' => 'integer', 'format' => 'int32', 'example' => '0', ], 'NamespaceList' => [ 'description' => 'List of namespaces', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Intervention scope', 'enumValueTitles' => ['namespace_qa_query （问答输入干预）' => 'namespace\\_qa\\_query (Q\\&A input intervention)', 'namespace_qa_result （问答结果干预）' => 'namespace\\_qa\\_result (Q\\&A result intervention)', 'namespace_writing_result （写作结果干预）' => 'namespace\\_writing\\_result (Writing result intervention)', 'namespace_writing_query （写作输入干预）' => 'namespace\\_writing\\_query (Writing input intervention)'], 'type' => 'string', 'example' => 'namespace_qa_query', 'title' => '', ], 'example' => '', ], 'RuleId' => ['title' => '', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => 'mr-iuo9pi9w555phfbb'], 'RuleName' => ['title' => '', 'description' => 'Rule name', 'type' => 'string', 'example' => 'ruletest'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'PageIndex' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Code' => ['description' => 'Status code returned by the intervention service', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'List intervention rules', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListInterveneRules', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListIntervenes' => [ 'summary' => 'Retrieves the list of intervention items.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identity of the workspace. For more information, see [AgentKey]().', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'], ], [ 'name' => 'RuleId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'mqtt_outRule_1679019634514'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The query.', 'type' => 'string', 'required' => false, 'example' => '小猫'], ], [ 'name' => 'InterveneType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The intervention type.', 'enumValueTitles' => ['0-相似问干预项目' => '0-Similar query intervention item', '2-正则表达式干预项 ' => '2-Regular expression intervention item', ' 1-关键词表达式干预项 ' => '1-Keyword expression intervention item', '3-关键词库干预项' => '3-Keyword library intervention item', ' 4-URL干预' => '4-URL intervention'], 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '干预类型', ], ], [ 'name' => 'PageIndex', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => '0'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'InterveneList' => [ 'description' => 'The list of intervention items.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The ID.', 'type' => 'string', 'example' => '36559'], 'Query' => ['title' => '', 'description' => 'The intervention query.', 'type' => 'string', 'example' => '伊家楼'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'PageIndex' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalSize' => ['title' => '', 'description' => 'The total number of pages.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'Code' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '428DCC0D-3C63-5306-BD1B-124396AB97BE'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. True for success, false for failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'List intervention items ', 'changeSet' => [ ['createdAt' => '2025-05-15T03:04:47.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListIntervenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListMaterialDocuments' => [ 'summary' => 'Retrieve the list of materials from the Material Library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Supports comprehensive queries for title, content, and content.', 'type' => 'string', 'required' => false, 'example' => '小猫'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Material primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '69', 'required' => false], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Performs a full-text search on material titles.', 'type' => 'string', 'required' => false, 'example' => '新闻标题'], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Document type (html: web page, plainText: plain text, image: image, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)', 'type' => 'string', 'example' => 'jsonLine', 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine', 'video', 'text'], 'required' => false, ], ], [ 'name' => 'DocTypeList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Document type list (html: web page, plainText: plain text, image: image, pdf: pdf, word: word, excel: excel, csv: csv, jsonLine: jsonLine)', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'File type object.', 'type' => 'string', 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine'], 'required' => false, 'example' => 'html', 'title' => '', ], 'required' => false, 'example' => 'excel', ], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Full-text search of document content', 'type' => 'string', 'required' => false, 'example' => '新闻内容'], ], [ 'name' => 'ShareAttr', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Share property: 0: personal private, 1: shared within the workspace.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['0', '1'], 'required' => false, ], ], [ 'name' => 'Keywords', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Document keywords.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Keyword.', 'type' => 'string', 'required' => false, 'example' => '关键词', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Creation time - start range. Format: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-02-19 07:28:11'], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Creation time - end range. Format: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'], ], [ 'name' => 'UpdateTimeStart', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Update time - start range. Format: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 02:00:00'."\n"], ], [ 'name' => 'UpdateTimeEnd', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Update time - end range. Format: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'required' => false, 'example' => '2023-03-18 03:00:00'."\n"], ], [ 'name' => 'GeneratePublicUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Generate a public URL for the file.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Returns the paginated list of materials.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Current' => ['description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'List object.', 'type' => 'array', 'items' => [ 'description' => 'Material object.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'Author.', 'type' => 'string', 'example' => '作者'."\n" ."\n"], 'CreateTime' => ['title' => '', 'description' => 'Creation time.', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"], 'CreateUser' => ['title' => '', 'description' => 'Creator user ID.', 'type' => 'string', 'example' => '"1"'], 'CreateUserName' => ['title' => '', 'description' => 'Creator username.', 'type' => 'string', 'example' => '创建用户名'], 'DocKeywords' => [ 'description' => 'Document tags used for categorization. Separate keywords with commas.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Keyword.', 'type' => 'string', 'example' => '关键词', 'title' => ''], 'example' => '', ], 'DocType' => ['title' => '', 'description' => 'Document type: pdf, word, url, or image.', 'type' => 'string', 'example' => 'pdf'], 'ExternalUrl' => ['title' => '', 'description' => 'URL uploaded by an external customer, used only for record keeping.', 'type' => 'string', 'example' => 'https://www.example.com'."\n"], 'HtmlContent' => ['description' => 'Web page content.', 'type' => 'string', 'example' => '网页内容', 'title' => ''], 'Id' => ['title' => '', 'description' => 'Primary key.', 'type' => 'integer', 'format' => 'int64', 'example' => '35'], 'PubTime' => ['title' => '', 'description' => 'Publish time. Format: yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"], 'PublicUrl' => ['title' => '', 'description' => 'Temporary public URL.', 'type' => 'string', 'example' => 'https://www.example.com'."\n"], 'ShareAttr' => [ 'title' => '', 'description' => 'Public property, stored by bit. The first bit indicates if it is shared within the workspace, the second bit indicates if it is shared within the tenant, and the third bit indicates if it is shared system-wide.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['0', '1'], ], 'SrcFrom' => ['title' => '', 'description' => 'Document source: user\\_upload, search, or viewpoint.', 'type' => 'string', 'example' => 'user_upload'], 'Summary' => ['title' => '', 'description' => 'Document summary.', 'type' => 'string', 'example' => '摘要'], 'TextContent' => ['title' => '', 'description' => 'Parsed text content. This is empty for images.', 'type' => 'string', 'example' => '文档内容'], 'ThumbnailInBase64' => ['title' => '', 'description' => 'Base64 thumbnail for image document types.', 'type' => 'string', 'example' => 'base64编码的图像二进制数据'], 'Title' => ['title' => '', 'description' => 'Document title.', 'type' => 'string', 'example' => '文档标题'."\n" ."\n"], 'UpdateTime' => ['title' => '', 'description' => 'Modification time.', 'type' => 'string', 'example' => '2023-03-18 02:00:00'."\n"], 'UpdateUser' => ['title' => '', 'description' => 'Modifier user ID.', 'type' => 'string', 'example' => '"1"'], 'UpdateUserName' => ['title' => '', 'description' => 'The name of the user who updated the document.', 'type' => 'string', 'example' => '更新用户名'], 'Url' => ['title' => '', 'description' => 'URL for internal document storage. Supports multiple protocols (http\\://, file://, ftp\\://). This URL is saved to internal storage when a customer uploads a file, stored long-term, and deleted upon expiration.', 'type' => 'string', 'example' => 'https://www.example.com'], 'FileKey' => ['description' => 'Unique file identity.', 'type' => 'string', 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx', 'title' => ''], 'FileAttr' => [ 'description' => 'Media file properties.', 'type' => 'object', 'properties' => [ 'Duration' => ['description' => 'Duration.', 'type' => 'number', 'format' => 'double', 'example' => '120', 'title' => ''], 'FileName' => ['description' => 'File name.', 'type' => 'string', 'example' => 'xxx.mp4', 'title' => ''], 'Width' => ['description' => 'Video width.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'MimeType' => ['description' => 'File MIME type.', 'type' => 'string', 'example' => 'image/png', 'title' => ''], 'FileLength' => ['description' => 'File content length.', 'type' => 'integer', 'format' => 'int64', 'example' => '1048576', 'title' => ''], 'Height' => ['description' => 'Video height.', 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Unique request identity.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Size' => ['description' => 'Number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'false'], 'Total' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'Retrieve Material List ', 'changeSet' => [ ['createdAt' => '2025-05-12T06:20:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-05-09T07:40:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListMaterialDocuments'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListMaterialDocuments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListPlanningProposal' => [ 'summary' => 'Retrieves a list of planning proposals.', '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' => '', 'description' => 'The unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'ViewPointType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Planning proposal type'."\n" ."\n" .'- CustomViewPoints: Custom viewpoint'."\n" ."\n" .'- HotViewPoints: Hot viewpoint'."\n" ."\n" .'- TimedViewPoints: Time-sensitive viewpoint'."\n" ."\n" .'- WebReviewPoints: User viewpoint'."\n" ."\n" .'- FreshViewPoints: Fresh viewpoint', 'type' => 'string', 'required' => true, 'example' => 'CustomViewPoints'], ], [ 'name' => 'Titles', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Filter planning proposal titles, corresponding to the viewpoint names of each planning proposal type.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Viewpoint filter.', 'type' => 'string', 'example' => '标题'."\n" .' * ', 'required' => false], 'required' => false, 'example' => '标题'."\n" .' * ', ], ], [ 'name' => 'CustomViewPointId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom viewpoint ID (used for custom viewpoint planning proposal scenarios).', 'type' => 'string', 'example' => 'e7b26a9e1211444db8f0a984361a5e0f', 'required' => false], ], [ 'name' => 'CustomViewPointIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of custom viewpoint IDs (used for custom viewpoint planning proposal scenarios).', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Custom viewpoint ID (used for custom viewpoint planning proposal scenarios)'."\n" .'\\*', 'type' => 'string', 'example' => '3c67e87fc9044a8aae534f617195ab31', 'required' => false], 'required' => false, 'example' => '27971fc8f3ce4ed58c7e7fc4b503e432', ], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot topic source.', 'type' => 'string', 'required' => true, 'example' => '热榜源'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot topic subject.', 'type' => 'string', 'required' => true, 'example' => '热榜主题'], ], [ 'name' => 'TopicVersion', 'in' => 'formData', 'schema' => ['description' => 'Hot spot event data version.', 'type' => 'string', 'example' => '2024-09-10_08', 'required' => false, 'title' => ''], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Token for the next page.', 'type' => 'string', 'example' => '下一页的Token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Maximum number of returned results.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '73', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Planning proposal object.', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'Outline list.', 'type' => 'array', 'items' => [ 'description' => 'Outline object.', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'Outline.', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['title' => '', 'description' => 'Outline summary.', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Summary' => ['description' => 'Summary.', 'type' => 'string', 'example' => '摘要', 'title' => ''], 'Title' => ['description' => 'Title.', 'type' => 'string', 'example' => '标题', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['title' => '', 'description' => 'Maximum number of returned results.', 'type' => 'integer', 'format' => 'int32', 'example' => '77'], 'Message' => ['title' => '', 'description' => 'Fault description.', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['title' => '', 'description' => 'Token for the next page.', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['title' => '', 'description' => 'Unique request identity.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '80'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve topic planning list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListPlanningProposal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListPptArtifacts' => [ 'summary' => 'Queries a list of PPT artifacts.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The workspace ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'llm-az2xxxx'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token for the next page.', 'type' => 'string', 'required' => false, 'example' => 'cEoBWREAXdxaOyjq/cqAbg==', 'title' => ''], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['description' => 'The search keyword for the work name.', 'type' => 'string', 'required' => false, 'example' => '数字时代的营销策划与文案创作', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The number of data entries to query in this request (deprecated).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Current' => ['description' => 'The current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-01-04 11:46:07'], 'Id' => ['description' => 'The unique ID of the document.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], 'Title' => ['description' => 'The title.', 'type' => 'string', 'title' => '', 'example' => '作品标题'], 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'title' => '', 'example' => '2025-04-14 19:59:53'], 'FileKey' => ['description' => 'The preview image of the work file.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jpg', 'title' => ''], 'FileAttr' => [ 'type' => 'object', 'properties' => [ 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => '数字时代的营销策划与文案创作', 'title' => ''], 'Width' => ['description' => 'The width of the video.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'TmpUrl' => ['description' => 'The preview image of the work file.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jpg', 'title' => ''], 'Height' => ['description' => 'The height.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], ], 'description' => 'The properties of the work file.', 'title' => '', 'example' => '', ], ], 'description' => 'The data.', 'title' => '', 'example' => '', ], 'description' => 'Indicates whether the deletion succeeded.', 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Size' => ['description' => 'The number of entries per page. The default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NextToken' => ['description' => 'The token for the next page.', 'type' => 'string', 'example' => 'cEoBWREAXdxaOyjq/cqAbg=='."\n", 'title' => ''], 'MaxResults' => ['description' => 'The number of entries returned in this response.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'title' => '', 'description' => 'The response.', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'ListPptArtifacts', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListPptArtifacts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'ListPptTemplates' => [ 'summary' => 'Queries a list of PowerPoint templates.', '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' => '', 'description' => 'The workspace ID.', 'type' => 'string', 'required' => false, 'example' => 'llm-xx'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => '+CBOXvu2YLxC6DOua8Qupg==', 'title' => ''], ], [ 'name' => 'MaxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '暂不支持修改，固定为10', 'title' => ''], ], [ 'name' => 'SceneId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The template scenario ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7'], ], [ 'name' => 'StyleId', 'in' => 'formData', 'schema' => ['description' => 'The style ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'ColourId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The color ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ 'name' => 'CareerId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The career ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Current' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'description' => 'The template data.', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'The ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10'], 'CoverImg' => ['title' => '', 'description' => 'The template thumbnail.', 'type' => 'string', 'example' => 'http://xxx.com/a.png'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Size' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NextToken' => ['description' => 'The token used to retrieve the next page of results.', 'type' => 'string', 'example' => '+CBOXvu2YLxC6DOua8Qupg==', 'title' => ''], 'MaxResults' => ['description' => 'The maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Query PPT template list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListPptTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'ListSearchTaskDialogueDatas' => [ 'summary' => 'Lists the dialogue data for a search generation task.', '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' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The query conditions.', 'type' => 'string', 'example' => 'xx', 'required' => false], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the task.'."\n" ."\n" .'> You do not need to specify this parameter. The system automatically generates a task ID. If you specify the same task ID for multiple tasks, the tasks are considered part of the same dialogue group.', 'type' => 'string', 'example' => 'xxx', 'required' => false], ], [ 'name' => 'OriginalSessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the historical dialogue. This is the source of all original materials.', 'type' => 'string', 'example' => 'xx', 'required' => false], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the historical dialogue. This is the source of reference materials.', 'type' => 'string', 'required' => true, 'example' => 'xx'], ], [ 'name' => 'MultimodalSearchType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The type of data to search.', 'type' => 'string', 'example' => 'text', 'required' => false], ], [ 'name' => 'SearchModel', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The type of search agent.', 'type' => 'string', 'example' => 'ClusterGenerate', 'required' => false], ], [ 'name' => 'SearchModelDataValue', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The data under the search agent classification.', 'type' => 'string', 'example' => 'xxx', 'required' => false], ], [ 'name' => 'IncludeContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Indicates whether to include the main content.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '10', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response result.', 'title' => '', 'type' => 'object', 'properties' => [ 'RealtimeSearch' => ['title' => '', 'description' => 'Indicates whether real-time search is enabled.', 'type' => 'boolean', 'example' => 'true'], 'SearchType' => ['title' => '', 'description' => 'The search type.', 'type' => 'string', 'example' => 'realtime'], 'Articles' => [ 'description' => 'The list of articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The article.', 'type' => 'object', 'properties' => [ 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-11-25 14:25:59'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '新华社'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容'], 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], 'Summary' => ['title' => '', 'description' => 'The summary of the article.', 'type' => 'string', 'example' => '文章摘要'], 'DocUuid' => ['title' => '', 'description' => 'The internal unique identifier of the document.', 'type' => 'string', 'example' => 'xxx'], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID'], 'MultimodalMedias' => [ 'description' => 'The multi-modal information.', 'type' => 'array', 'items' => [ 'description' => 'The multi-modal information.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique identifier of the multi-modal data.', 'type' => 'string', 'example' => '多模态数据唯一标识'], 'MediaType' => ['title' => '', 'description' => 'The type of the multi-modal data.', 'type' => 'string', 'example' => '多模态数据类型'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the image or video file.', 'type' => 'string', 'example' => '图片或视频文件地址'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'DocType' => ['title' => '', 'description' => 'The document type.', 'type' => 'string', 'example' => 'text'], 'CategoryUuid' => ['title' => '', 'description' => 'The unique identifier of the category.', 'type' => 'string', 'example' => 'xx'], 'Extend1' => ['title' => '', 'description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx'], 'Extend2' => ['title' => '', 'description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx'], 'Extend3' => ['title' => '', 'description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Images' => [ 'description' => 'The list of images.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The image object.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique identifier of the multi-modal data.', 'type' => 'string', 'example' => '多模态数据唯一标识'], 'MediaType' => ['title' => '', 'description' => 'The type of the multi-modal data.', 'type' => 'string', 'example' => '多模态数据类型'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the image or video file.', 'type' => 'string', 'example' => '图片或视频文件地址'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Videos' => [ 'description' => 'The list of videos.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The list of video information.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique identifier of the multi-modal data.', 'type' => 'string', 'example' => '多模态数据唯一标识'], 'MediaType' => ['title' => '', 'description' => 'The type of the multi-modal data.', 'type' => 'string', 'example' => '多模态数据类型'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the image or video file.', 'type' => 'string', 'example' => '图片或视频文件地址'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'The number of records on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success, and a value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Audios' => [ 'description' => 'The list of audio files.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The audio information.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique identifier of the multi-modal data.', 'type' => 'string', 'example' => 'xxxx'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the image or video file.', 'type' => 'string', 'example' => 'http://xxx'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Query the data list in the details of a search-generated Job', 'changeSet' => [ ['createdAt' => '2025-09-29T12:05:41.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListSearchTaskDialogueDatas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListSearchTaskDialogues' => [ 'summary' => 'Retrieves the task details for MiaoSou search generation tasks.', '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' => '', 'description' => 'The unique ID of the Model Studio workspace. For more information, see [Obtain a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task.'."\n" ."\n" .'> You do not need to specify this parameter. The system generates it automatically. If you specify the same TaskId for multiple tasks, they are grouped into the same conversation.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ 'SessionId' => ['title' => '', 'description' => 'The unique ID of a single-turn conversation.', 'type' => 'string', 'example' => 'xxxx'], 'OriginSessionId' => ['title' => '', 'description' => 'The original session ID.', 'type' => 'string', 'example' => 'xxxx'], 'TaskId' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'example' => 'xxxx'], 'Rating' => ['title' => '', 'description' => 'The rating of the content, which can be Like or Dislike.', 'type' => 'string', 'example' => 'thumbsUp'], 'Tags' => [ 'description' => 'The tags.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The tag.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'Text' => ['title' => '', 'description' => 'The customer feedback.', 'type' => 'string', 'example' => 'xxx'], 'GoodText' => ['title' => '', 'description' => 'The generated content that the customer rated as good.', 'type' => 'string', 'example' => 'xxx'], 'Prompt' => ['title' => '', 'description' => 'The input prompt.', 'type' => 'string', 'example' => 'xxx'], 'CreateTime' => ['title' => '', 'description' => 'The time when the task was created.', 'type' => 'string', 'example' => '2024-11-25 13:33:01'], 'DialogueType' => ['title' => '', 'description' => 'The type of generation.', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], 'ResponseBodyStr' => ['title' => '', 'description' => 'The response body as a string.', 'type' => 'string', 'example' => '{}'], 'ChatConfig' => [ 'description' => 'The configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'GenerateTechnology' => ['title' => '', 'description' => 'The type of content generation.', 'type' => 'string', 'example' => 'copilotReference'], 'SearchParam' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'SearchSources' => [ 'description' => 'The search sources.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The search source.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The type.', 'type' => 'string', 'example' => 'x\'x'], 'Name' => ['title' => '', 'description' => 'The description.', 'type' => 'string', 'example' => 'x'], 'DatasetName' => ['title' => '', 'description' => 'The unique ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'example' => '', ], 'EndTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'StartTime' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'MultimodalSearchTypes' => [ 'description' => '', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'DialogueType' => ['title' => '', 'description' => 'The request type.', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], 'GenerateLevel' => ['title' => '', 'description' => 'The generation level.', 'type' => 'string', 'example' => 'concise'], 'EndToEnd' => ['title' => '', 'description' => 'Indicates whether the process is end-to-end.', 'type' => 'boolean', 'example' => ''], 'SearchModels' => [ 'description' => 'The search type.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'The search type.', 'type' => 'string', 'example' => 'TextGenerate'], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'The number of the page returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], '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\\": false,\\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' => 'Query the list of MiaoSousuo search generation job details', 'changeSet' => [ ['createdAt' => '2025-05-08T04:13:51.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListSearchTaskDialogues', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListSearchTasks' => [ 'summary' => 'Queries the list of historical tasks generated by Miaosou Search.', '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' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain workspaceId]().', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'DialogueTypes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Task type', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Task type', 'type' => 'integer', 'format' => 'int32', 'example' => '24', 'required' => false, 'title' => ''], 'required' => false, 'example' => '24', ], ], [ 'name' => 'PageNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '1', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '10', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response result', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Business data', 'type' => 'array', 'items' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Unique task identifier', 'type' => 'string', 'example' => 'xxxx'], 'TaskName' => ['title' => '', 'description' => 'Task name', 'type' => 'string', 'example' => 'xxx'], 'CreateTime' => ['title' => '', 'description' => 'Creation time', 'type' => 'string', 'example' => '2024-11-25 11:40:50'], 'UpdateTime' => ['title' => '', 'description' => 'Modification time', 'type' => 'string', 'example' => '2024-11-25 11:40:50'], 'DialogueType' => ['title' => '', 'description' => 'Task type', 'type' => 'integer', 'format' => 'int32', 'example' => '24'], 'Username' => ['title' => '', 'description' => 'Creator name', 'type' => 'string', 'example' => 'xxxx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'PageNumber' => ['title' => '', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'PageSize' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'TotalCount' => ['title' => '', 'description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. True for success, false for failed.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], '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' => 'Query the History Job List of Miaosou Search and Generation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListSearchTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListStyleLearningResult' => [ 'summary' => 'Retrieves the list of style learning analysis results.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Current', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'Size', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Number of items per page. Default is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Page result', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Current' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Data' => [ 'description' => 'List of style learning analysis results', 'type' => 'array', 'items' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'AigcResult' => ['title' => '', 'description' => 'AIGC-generated content', 'type' => 'string', 'example' => 'AIGC 生成的内容'], 'Id' => ['title' => '', 'description' => 'ID of the style learning analysis result', 'type' => 'integer', 'format' => 'int64', 'example' => '70'], 'RewriteResult' => ['title' => '', 'description' => 'Revised content', 'type' => 'string', 'example' => '用户修订后内容'], 'StyleName' => ['title' => '', 'description' => 'Style name', 'type' => 'string', 'example' => '文体风格名称'], 'TaskId' => ['title' => '', 'description' => 'Task ID used for style analysis', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Size' => ['title' => '', 'description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Success' => ['title' => '', 'description' => 'Indicates success. Returns true on success and false on failure.', 'type' => 'boolean', 'example' => 'true'], 'Total' => ['title' => '', 'description' => 'Total number of items', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve the list of style learning analysis results ', 'description' => 'The Quanmiao product supports iframe embedding. For details, see [Customer Integration: Quanmiao Public Cloud iframe Customization Plan](~~3000990~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListTimedViewAttitude' => [ 'summary' => 'List of timeliness perspectives.', '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' => ['description' => 'UUID of the workspace: AgentKey', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['description' => 'Hotlist source', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜源'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['description' => 'Hotlist topic', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜主题'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Token for the next page', 'title' => '', 'type' => 'string', 'example' => '下一页的Token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of Return Results', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '53', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status Code', 'title' => '', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business Data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Timeliness perspective object', 'type' => 'object', 'properties' => [ 'Attitude' => ['description' => 'current attitude', 'title' => '', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['description' => 'Attitude Type', 'title' => '', 'type' => 'string', 'example' => '观点类型'], 'PubTime' => ['description' => 'Published At', 'title' => '', 'type' => 'string', 'example' => '2024-01-22 10:29'], 'Ratio' => ['description' => 'Proportion of the current attitude', 'title' => '', 'type' => 'string', 'example' => '当前观点占比'], 'Source' => ['description' => 'News Source', 'title' => '', 'type' => 'string', 'example' => '新浪'], 'Title' => ['description' => 'Current attitude, equivalent to the news title', 'title' => '', 'type' => 'string', 'example' => '标题'], 'Url' => ['description' => 'News URL', 'title' => '', 'type' => 'string', 'example' => 'http://www.example.com/news/1.html'], 'ViewPoints' => [ 'description' => 'List of topic perspectives', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Perspective object', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'outlines', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'outline', 'type' => 'object', 'properties' => [ 'Outline' => ['description' => 'outline', 'title' => '', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['description' => 'outline summary', 'title' => '', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['description' => 'generated point', 'title' => '', 'type' => 'string', 'example' => '视角'], 'Summary' => ['description' => 'Summary', 'title' => '', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['description' => 'Maximum number of return results', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '15'], 'Message' => ['description' => 'Fault description', 'title' => '', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['description' => 'Token for the next page', 'title' => '', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['description' => 'Request UUID', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded: true for success, false for failure', 'title' => '', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['description' => 'Total count', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '58'], ], 'example' => '', ], ], ], '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' => 'Retrieve Timeliness Perspective List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListTimedViewAttitude', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListTopicRecommendEventList' => [ 'summary' => 'Retrieve hot spot recommendation events.', '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' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Token for the next page', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Maximum number of results to return', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '72', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'List of hot spot events', 'type' => 'array', 'items' => ['description' => 'Hot spot event', 'type' => 'string', 'example' => '热点事件', 'title' => ''], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['description' => 'Maximum number of records returned', 'type' => 'integer', 'format' => 'int32', 'example' => '71', 'title' => ''], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['description' => 'Next page token', 'type' => 'string', 'example' => 'x\'x\'x', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Whether the request was successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve the list of hot spot recommendation management events', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListTopicRecommendEventList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListTopicViewPointRecommendEventList' => [ 'summary' => 'Retrieves recommended viewpoints for hot spot events.', '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' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Token for the next page.', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Maximum number of results to return. Defaults to 5.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '66', 'required' => false], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'Hot spot event ID.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'List of popular viewpoints.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['title' => '', 'description' => 'Maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '8'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['title' => '', 'description' => 'Token for the next page.', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve the list of recommended viewpoints for hot spot events', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListTopicViewPointRecommendEventList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListVersions' => [ 'summary' => 'Retrieve version information for your purchased services.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'List item', 'type' => 'object', 'properties' => [ 'ConcurrentCount' => ['title' => '', 'description' => 'Concurrency', 'type' => 'integer', 'format' => 'int32', 'example' => '43'], 'EndTime' => ['title' => '', 'description' => 'Service expiration time', 'type' => 'string', 'example' => '2023-04-23 02:00:34'], 'InstanceCount' => ['title' => '', 'description' => 'Number of instances', 'type' => 'integer', 'format' => 'int32', 'example' => '55'], 'InstanceId' => ['title' => '', 'description' => 'Instance ID', 'type' => 'string', 'example' => 'ga-bp12pismsw4v3tzhf62p1'], 'OrderId' => ['title' => '', 'description' => 'Order ID', 'type' => 'integer', 'format' => 'int64', 'example' => '7'], 'ProductType' => [ 'title' => '', 'description' => 'Version type (TRIAL: trial edition, STANDARD: Standard Edition, CUSTOMIZE: custom edition)', 'type' => 'string', 'example' => 'CUSTOMIZE', 'enum' => ['TRIAL', 'STANDARD', 'CUSTOMIZE'], ], 'Quota' => ['title' => '', 'description' => 'Trial edition quota', 'type' => 'integer', 'format' => 'int32', 'example' => '13'], 'StartTime' => ['title' => '', 'description' => 'Service start time', 'type' => 'string', 'example' => '2023-05-27 04:11:00'], 'UseQuota' => ['title' => '', 'description' => 'Trial edition usage count', 'type' => 'integer', 'format' => 'int32', 'example' => '65'], 'VersionDetail' => ['title' => '', 'description' => 'Version details', 'type' => 'string', 'example' => '标准版-公共并发：1并发'], 'VersionName' => [ 'title' => '', 'description' => 'Version', 'type' => 'string', 'example' => '试用版', 'enum' => ['试用版', '专业版', '定制版'], ], 'VersionStatus' => ['title' => '', 'description' => 'Validity status: 0 indicates active, 1 indicates expired (go to the renewal page), and 2 indicates unavailable (go to the purchase page)', 'type' => 'integer', 'format' => 'int32', 'example' => '87'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Obtain version information', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'ListVersions'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'ListWebReviewPoints' => [ 'summary' => 'List of viewpoints from netizens.', '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' => ['description' => 'UUID of the workspace: AgentKey ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['description' => 'Hotlist source ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜源'], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['description' => 'Hotlist topic ', 'title' => '', 'type' => 'string', 'required' => true, 'example' => '热榜主题'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['description' => 'Token for the next page ', 'title' => '', 'type' => 'string', 'example' => '下一页的token', 'required' => false], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['description' => 'Maximum number of returned results ', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'minimum' => '0', 'example' => '81', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PageResult2', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code ', 'title' => '', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business Data', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Attitude' => ['description' => 'Current viewpoint ', 'title' => '', 'type' => 'string', 'example' => '当前观点'], 'AttitudeType' => ['description' => 'Viewpoint type ', 'title' => '', 'type' => 'string', 'example' => '观点类型'], 'Comments' => [ 'description' => 'List of user opinions', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Source' => ['description' => 'Source', 'title' => '', 'type' => 'string', 'example' => '来源'], 'Text' => ['description' => 'Content', 'title' => '', 'type' => 'string', 'example' => '内容'], 'Title' => ['description' => 'title', 'title' => '', 'type' => 'string', 'example' => '标题'], 'Url' => ['description' => 'Current URL', 'title' => '', 'type' => 'string', 'example' => '当前所属的URL'], 'Username' => ['description' => 'username', 'title' => '', 'type' => 'string', 'example' => '用户名'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Ratio' => ['description' => 'Proportion of the current opinion', 'title' => '', 'type' => 'string', 'example' => '当前观点占比'], 'ViewPoints' => [ 'description' => 'List of topic perspectives', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outlines' => [ 'description' => 'Outline ', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Outline' => ['description' => 'Outline ', 'title' => '', 'type' => 'string', 'example' => '大纲'], 'Summary' => ['description' => 'Outline summary ', 'title' => '', 'type' => 'string', 'example' => '大纲摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Point' => ['description' => 'Generated point ', 'title' => '', 'type' => 'string', 'example' => '视角'], 'Summary' => ['description' => 'Summary', 'title' => '', 'type' => 'string', 'example' => '摘要'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'MaxResults' => ['description' => 'Maximum number of return results', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '79'], 'Message' => ['description' => 'Fault description', 'title' => '', 'type' => 'string', 'example' => 'success'], 'NextToken' => ['description' => 'Token for the next page', 'title' => '', 'type' => 'string', 'example' => '下一页的token'], 'RequestId' => ['description' => 'Request UUID', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded: true for success, false for failure ', 'title' => '', 'type' => 'boolean', 'example' => 'true'], 'TotalCount' => ['description' => 'Total count', 'title' => '', 'type' => 'integer', 'format' => 'int32', 'example' => '32'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve the list of netizen perspectives ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListWebReviewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'ListWritingStyles' => [ 'summary' => 'Retrieves the list of writing styles.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'query', 'schema' => ['title' => '', 'description' => '[The workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'], ], [ 'name' => 'Scene', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Filters by writing scenario.', 'enumValueTitles' => ['market' => 'Marketing writing', 'government' => 'Official documents', 'custom' => 'Custom writing', 'media' => 'Media', 'office' => 'Business documents'], 'type' => 'string', 'required' => true, 'example' => 'media', ], ], [ 'name' => 'MaxResults', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100'], ], [ 'name' => 'NextToken', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Pagination token', 'type' => 'string', 'required' => false, 'example' => '下一页token'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'TotalCount' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '58'], 'MaxResults' => ['description' => 'The maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'NextToken' => ['title' => '', 'description' => 'The next token.', 'type' => 'string', 'example' => '下一页token'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'successful'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '数据不存在'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true'], 'Data' => [ 'description' => 'The list of writing styles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A writing style object.', 'title' => '', 'type' => 'object', 'properties' => [ 'StyleName' => ['title' => '', 'description' => 'The name of the writing style.', 'type' => 'string', 'example' => '文体名称'], 'StyleKey' => ['title' => '', 'description' => 'The unique key of the writing style.', 'type' => 'string', 'example' => '文体唯一标识'], 'StyleDescription' => ['title' => '', 'description' => 'The description of the writing style.', 'type' => 'string', 'example' => '文体描述'], 'DistributeWriting' => ['title' => '', 'description' => 'Indicates whether step-by-step writing is supported.', 'type' => 'boolean', 'example' => 'false'], 'StyleImage' => ['title' => '', 'description' => 'The image for the writing style.', 'type' => 'string', 'example' => '文体图片'."\n" ."\n"], 'Emoji' => ['title' => '', 'description' => 'The icon for the writing style, represented by a character.', 'type' => 'string', 'example' => '小图标'], 'TemplateDefine' => ['description' => 'The template definition for the writing style.', '$ref' => '#/components/schemas/WritingStyleTemplateDefine', 'title' => '', 'example' => ''], 'DistributeStepTemplateDefine' => ['description' => 'The template definition for step-by-step writing.', '$ref' => '#/components/schemas/WritingStyleTemplateDefine', 'title' => '', 'example' => ''], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Retrieve the list of writing styles', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListWritingStyles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'QueryAsyncTask' => [ 'summary' => 'Queries the details of submitted asynchronous task executions.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique ID of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => '33a2658aaabf4c24b45d50e575125311_p_beebot_public'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique task ID'."\n" ."\n" .'> The system automatically generates the TaskId by default. If subsequent tasks use the same TaskId, they belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'success'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'CreateTime' => ['title' => '', 'description' => 'Creation date', 'type' => 'string', 'example' => '2021-07-25 14:34:33'], 'CreateUser' => ['title' => '', 'description' => 'Creator', 'type' => 'string', 'example' => '"12121"'."\n"], 'TaskCode' => ['title' => '', 'description' => 'Task ID, indicates the specific task.', 'type' => 'string', 'example' => 'MaterialDocumentUpload'], 'TaskErrorMessage' => ['title' => '', 'description' => 'Task execution error message', 'type' => 'string', 'example' => 'error'], 'TaskId' => ['title' => '', 'description' => 'Unique task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskIntermediateResult' => ['title' => '', 'description' => 'Intermediate task execution result. When a task has multiple steps, save the output of each step here. When resuming from a pause, read the intermediate result and continue from there.', 'type' => 'string', 'example' => '"{}"'], 'TaskName' => ['title' => '', 'description' => 'Task name', 'type' => 'string', 'example' => '任务名称'], 'TaskParam' => ['title' => '', 'description' => 'Task execution input parameters, JSON format', 'type' => 'string', 'example' => '"{\\"fileKey\\":\\"oss://default/xxxx/xxxx/xxx\\",\\"fileName\\":\\"xxxxx.doc\\"}"'], 'TaskProgressMessage' => ['title' => '', 'description' => 'Task execution progress message', 'type' => 'string', 'example' => '"{}"'], 'TaskResult' => ['title' => '', 'description' => 'Task execution result message', 'type' => 'string', 'example' => '"{}"'], 'TaskRetryCount' => ['title' => '', 'description' => 'Number of task retries', 'type' => 'string', 'example' => '"3"'], 'TaskStatus' => ['title' => '', 'description' => 'Task execution status: 0-Pending, 1-Executing, 2-Execution successful, 3-Paused, 4-Execution failed (retryable), 5-Execution failed (not retryable), 6-Task canceled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'UpdateTime' => ['title' => '', 'description' => 'Update date', 'type' => 'string', 'example' => '2023-04-27 18:07:43'], 'UpdateUser' => ['title' => '', 'description' => 'Updater', 'type' => 'string', 'example' => '"12121"'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '867C4ABE-4381-5BC2-9810-5A5F334F71CF'], 'Success' => ['title' => '', 'description' => 'Success status: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Query asynchronous task details ', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'QueryAsyncTask'], ], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:QueryAsyncTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'QueryAuditTask' => [ 'summary' => 'Queries the results of an audit task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ContentAuditTaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Audit task ID (Choose either task ID or article ID)', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'ArticleId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Article ID (Choose either task ID or article ID)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-xxxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP error code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'Asynchronous task object', 'type' => 'object', 'properties' => [ 'TaskStatus' => ['title' => '', 'description' => 'Task execution status: 0: pending, 1: running, 2: successful, 3: paused, 4: failed, 6: canceled', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Content' => ['title' => '', 'description' => 'Original text at the time of audit.', 'type' => 'string', 'example' => '审核时的原文'], 'AuditTime' => ['title' => '', 'description' => 'Audit time.', 'type' => 'string', 'example' => '2025-05-13 12:12:12'], 'Response' => [ 'description' => 'Audit results.', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Audit response header', 'title' => '', 'type' => 'object', 'properties' => [ 'Event' => ['title' => '', 'description' => 'Event', 'type' => 'string', 'example' => 'task-failed'], 'ErrorCode' => ['title' => '', 'description' => 'error code', 'type' => 'string', 'example' => 'DataNotExists'], 'ErrorMessage' => ['title' => '', 'description' => 'error message', 'type' => 'string', 'example' => '数据不存在'], 'SessionId' => ['title' => '', 'description' => 'Unique conversation ID.', 'type' => 'string', 'example' => '49eab783-9172-487a-b9df-c6372c47392c'], 'TaskId' => ['title' => '', 'description' => 'Unique multi-turn conversation ID.', 'type' => 'string', 'example' => '896b733535274d28b1a61c78bc145217'], ], 'example' => '', ], 'Payload' => [ 'description' => 'response body', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'response body', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Final response result (JSON array structure)', 'type' => 'string', 'example' => 'x\'x\'x'], ], 'example' => '', ], 'Usage' => [ 'description' => 'usage', 'title' => '', 'type' => 'object', 'properties' => [ 'OutputTokens' => ['title' => '', 'description' => 'Output tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'InputTokens' => ['title' => '', 'description' => 'Input tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'TotalTokens' => ['title' => '', 'description' => 'Total tokens.', 'type' => 'integer', 'format' => 'int32', 'example' => '300'], ], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'Status' => ['title' => '', 'description' => 'Task execution status: PENDING: pending, RUNNING: running, SUCCESSED: successful, SUSPENDED: paused, FAILED: failed, CANCELLED: canceled', 'type' => 'string', 'example' => 'RUNNING'], 'HtmlContent' => ['title' => '', 'description' => 'Formatted content at the time of audit.', 'type' => 'string', 'example' => '格式化的审核时的内容'."\n" ."\n"], 'Title' => ['title' => '', 'description' => 'Content title', 'type' => 'string', 'example' => '内容标题'."\n" ."\n"], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Query review result ', 'changeSet' => [ ['createdAt' => '2025-05-15T10:00:27.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:QueryAuditTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'QueryVideoAuditResult' => [ 'summary' => 'Queries video audit results.', 'description' => 'Queries video audit results by task ID. The response includes video information, shot information, and audit results.', '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' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Task ID', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Business status code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Message' => ['description' => 'Return message', 'type' => 'string', 'example' => '查询成功', 'title' => ''], 'Success' => ['description' => 'Is successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Video audit result data', 'type' => 'object', 'properties' => [ 'Status' => [ 'description' => 'Task status (PENDING: Queued, RUNNING: In progress, SUCCESSED: Successful, FAILED: Failed, CANCELED: Task canceled)', 'type' => 'string', 'example' => 'SUCCESSED', 'enum' => ['PENDING', 'RUNNING', 'SUCCESSED', 'FAILED', 'CANCELED'], 'title' => '', ], 'ErrorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => '错误信息', 'title' => ''], 'Text' => ['description' => 'Reviewed text', 'type' => 'string', 'example' => '视频审核完成', 'title' => ''], 'VideoUrl' => ['description' => 'Video URL', 'type' => 'string', 'example' => 'https://example.com/video.mp4', 'title' => ''], 'VideoFileKey' => ['description' => 'Video FileKey', 'type' => 'string', 'example' => 'video/test.mp4', 'title' => ''], 'Duration' => ['description' => 'Video duration', 'type' => 'number', 'format' => 'double', 'example' => '120.5', 'title' => ''], 'Width' => ['description' => 'Video width', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'title' => ''], 'Height' => ['description' => 'Video height', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'title' => ''], 'Fps' => ['description' => 'Video frame rate', 'type' => 'number', 'format' => 'double', 'example' => '30.0', 'title' => ''], 'TotalFrames' => ['description' => 'Total frames', 'type' => 'integer', 'format' => 'int32', 'example' => '3615', 'title' => ''], 'TotalShots' => ['description' => 'Total shots', 'type' => 'integer', 'format' => 'int32', 'example' => '15', 'title' => ''], 'TotalFrameAudit' => ['description' => 'Frames to audit', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], 'FrameAudited' => ['description' => 'Frames audited', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'title' => ''], 'ImageUrls' => [ 'description' => 'Image URL list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Url' => ['description' => 'Image URL', 'type' => 'string', 'example' => 'https://example.com/image1.jpg', 'title' => ''], 'Id' => ['description' => 'Image ID (Associate with Results\\[].DataId to get audit result information)', 'type' => 'string', 'example' => 'img001', 'title' => ''], 'Timestamp' => ['description' => 'Timestamp (milliseconds)', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1000'], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Results' => [ 'description' => 'Audit results list', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ReqId' => ['description' => 'Request ID', 'type' => 'string', 'example' => 'B5D1CF9E-0404-51E3-A28E-A5C7D95B6C71', 'title' => ''], 'DataId' => ['description' => 'Image ID (Associate with ImageUrls\\[].Id to get image information)', 'type' => 'string', 'example' => 'd411ed15e8fc154fd0ef5addabfee04b', 'title' => ''], 'RiskLevel' => [ 'description' => 'Risk level'."\n" ."\n" .'- high: High risk'."\n" ."\n" .'- medium: Medium risk'."\n" ."\n" .'- low: Low risk'."\n" ."\n" .'- none: No risk', 'type' => 'string', 'example' => 'none', 'enum' => ['high', 'medium', 'low', 'none'], 'title' => '', ], 'Result' => [ 'description' => 'Detection results', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Label' => ['description' => 'Risk label'."\n" ."\n" .'The label of the image content review result. For example: nonLabel (no risk detected).'."\n" ."\n" .'The label can also be a risk level that is determined by the high-risk and low-risk thresholds that you set. Valid return values are:'."\n" .'● high: high risk'."\n" .'● medium: medium risk'."\n" .'● low: low risk'."\n" .'● none: no risk detected', 'type' => 'string', 'example' => 'nonLabel', 'title' => ''], 'Confidence' => ['description' => 'From 0 to 100, retained to 2 decimal places. Some labels do not have a confidence score.', 'type' => 'number', 'format' => 'float', 'example' => '99.5', 'title' => ''], 'Description' => ['description' => 'Explanation of the Label field', 'type' => 'string', 'example' => '未检测出风险', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Query result response', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'QueryVideoAuditResult', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:QueryVideoAuditResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'RunAbbreviationContent' => [ 'summary' => 'Abbreviates the specified content.', 'path' => '/quanmiao/aimiaobi/runAbbreviationContent', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for the Alibaba Cloud Model Studio workspace. Obtain the[ Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content to abbreviate.', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际，开发政务社交媒体的特色功能，如在线咨询服务、政策解读、互动问答等，增强政务社交媒体的互动性和实用性，提升公众参与度。'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom prompt.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'End' => ['title' => '', 'description' => 'Indicates whether the output is complete. True means it is complete.', 'type' => 'boolean', 'example' => ''], 'Header' => [ 'description' => 'The streaming output header, which contains general return information.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '403'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.'], 'Event' => ['title' => '', 'description' => 'Event type.', 'type' => 'string', 'example' => 'result-generated'], 'EventInfo' => ['title' => '', 'description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件'], 'SessionId' => ['title' => '', 'description' => 'The session ID for a single session.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'], 'TaskId' => ['title' => '', 'description' => 'The task ID for a single generation task.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], 'TraceId' => ['title' => '', 'description' => 'Trace ID for the request chain.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Result payload, JSON structure', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output content object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Output content.', 'type' => 'string', 'example' => '这是测试输出'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Large Language Model (LLM) token usage information.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'OutputTokens' => ['title' => '', 'description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'TotalTokens' => ['title' => '', 'description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"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' => 'Content Abbreviation', 'changeSet' => [ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunAbbreviationContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunAiHelperWriting' => [ 'summary' => 'MiaoBi: AI-assisted writing', 'path' => '/quanmiao/aimiaobi/runAiHelperWriting', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The [workspace](~~2782167~~) ID.', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx'], ], [ 'name' => 'WritingScene', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The writing scenario. Valid values: government, media, market, office, and custom.', 'type' => 'string', 'required' => true, 'example' => 'media'], ], [ 'name' => 'WritingStyle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique key for the writing style. Call the [ListWritingStyles](~~2922609~~) operation to get a list of styles for the specified scenario.', 'type' => 'string', 'required' => true, 'example' => '通知'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The prompt, which specifies the subject for the AI to write about.', 'type' => 'string', 'required' => true, 'example' => '请帮我写一篇关于人工智能发展趋势的文章'], ], [ 'name' => 'PromptMode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The prompt pattern. For example, PE indicates the advanced pattern and Template indicates the template pattern.', 'type' => 'string', 'example' => 'Template', 'required' => false], ], [ 'name' => 'DistributeWriting', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to generate the text step by step.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'WritingParams', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The writing parameters from the previous form, specified as key-value pairs.', 'additionalProperties' => ['title' => '', 'description' => 'The key and value of the writing parameter.', 'type' => 'string', 'example' => '{"topic":"写作主题"}'], 'title' => '', 'type' => 'object', 'required' => false, 'example' => '{"wordCount": "1000", "tone": "formal"}', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The Server-Sent Events (SSE) response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'InvalidParameter'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '参数错误'], 'Event' => ['title' => '', 'description' => 'The event type.', 'type' => 'string', 'example' => 'result-generated'], 'SessionId' => ['title' => '', 'description' => 'The session ID.', 'type' => 'string', 'example' => 'session-xxxxx'], 'StatusCode' => ['title' => '', 'description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'task-xxxxx'], 'TraceId' => ['title' => '', 'description' => 'Trace ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], ], 'example' => '', ], 'Payload' => [ 'description' => 'The response payload.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output content.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'The generated text.', 'type' => 'string', 'example' => '人工智能正在深刻改变我们的生活...'], 'WritingParams' => [ 'description' => 'The writing parameters for the AI-assisted writing.', 'additionalProperties' => ['title' => '', 'description' => 'A key-value pair.', 'type' => 'string', 'example' => '{"topic":"写作主题xxx"}'], 'title' => '', 'type' => 'object', 'example' => '{"wordCount": "1000"}', ], ], 'example' => '', ], 'Usage' => [ 'description' => 'The token usage.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '256'], 'OutputTokens' => ['title' => '', 'description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024'], 'TotalTokens' => ['title' => '', 'description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '1280'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200'], 'Code' => ['title' => '', 'description' => 'The business status code.', 'type' => 'string', 'example' => 'successful'], 'Message' => ['title' => '', 'description' => 'The returned message.', 'type' => 'string', 'example' => 'success'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'AI Writing Assistant', 'description' => 'QuanMiao products support iframe embedding. For more information, see [QuanMiao Public Cloud iframe Customization for Customer Onboarding](~~3000990~~).', 'requestParamsDescription' => '## Sample data'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "WorkspaceId": "llm-xxx",'."\n" .' "WritingScene": "office",'."\n" .' "WritingStyle": "speech",'."\n" .' "Prompt": "A speech on the topic of \'AI Ethics and Social Impact\'"'."\n" .'}'."\n" .'```', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunAiHelperWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'RunBookBrainmap' => [ 'path' => '/miaodu/stream/runBookBrainmap', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier for the Model Studio workspace. For more information, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-hx72jf15gqyobvd9', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'A prompt with additional instructions.', 'type' => 'string', 'example' => '按英文输出', 'required' => false, 'title' => ''], ], [ 'name' => 'CleanCache', 'in' => 'formData', 'schema' => ['description' => 'Specifies whether to clear the cache. The default is `false`.', 'type' => 'boolean', 'example' => 'true', 'required' => false, 'title' => ''], ], [ 'name' => 'NodeNumber', 'in' => 'formData', 'schema' => ['description' => 'The number of nodes on the second level of the mind map.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'required' => false, 'title' => ''], ], [ 'name' => 'WordNumber', 'in' => 'formData', 'schema' => ['description' => 'The number of words per node.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false, 'title' => ''], ], [ 'name' => 'ResponseFormat', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Header' => [ 'description' => 'The response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'task-failed', 'title' => ''], 'EventInfo' => ['description' => 'The event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '0bc1409b17210096103458421ec62e', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'The response payload.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The generated output.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'The mind map content.', 'type' => 'string', 'example' => '{"xxxx":"xxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Details about token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The input token count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'The output token count.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'The total token count.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Book Mind Map', 'summary' => 'Miaodu generates mind maps of books.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunBookBrainmap', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], '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"}]', 'translator' => 'machine', ], 'RunBookIntroduction' => [ 'summary' => 'Extracts a summary, structured selling points, and hotwords from a book.', 'path' => '/miaodu/stream/runBookIntroduction', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the workspace in Model Studio (Bailian). For more information, see [Get your workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-vtmox6g2bhq2qv5c', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => '3YQRatoe8phnpIsIE6z7DTPknhG8Fj', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '0f56f98a-f2d8-47ec-98e9-1cbdcffa9539', 'title' => ''], ], [ 'name' => 'SummaryPrompt', 'in' => 'formData', 'schema' => ['description' => 'A custom prompt for generating the summary.', 'type' => 'string', 'example' => '用英文输出', 'required' => false, 'title' => ''], ], [ 'name' => 'KeyPointPrompt', 'in' => 'formData', 'schema' => ['description' => 'A custom prompt for extracting key points.', 'type' => 'string', 'example' => '用英文输出', 'required' => false, 'title' => ''], ], [ 'name' => 'CleanCache', 'in' => 'formData', 'schema' => ['type' => 'boolean', 'example' => 'true', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Header' => [ 'description' => 'The response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'finished', 'title' => ''], 'EventInfo' => ['description' => 'The event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '411c4dfa-2168-4379-a902-675d67f453f8', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'The payload.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The generated content.', 'type' => 'object', 'properties' => [ 'Summary' => ['description' => 'The book summary.', 'type' => 'string', 'example' => '简介内容', 'title' => ''], 'KeyPoint' => ['description' => 'The book\'s key points.', 'type' => 'string', 'example' => '卖点内容', 'title' => ''], 'Introductions' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Summary' => ['description' => 'A summary of this section.', 'type' => 'string', 'example' => '本段摘要内容', 'title' => ''], 'Title' => ['description' => 'The title of this section.', 'type' => 'string', 'example' => '本段标题内容', 'title' => ''], 'Blocks' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Height' => ['description' => 'The height of the content block.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'PageId' => ['description' => 'The ID of the page where the content block is located.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'The width of the content block.', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'X' => ['description' => 'The x-coordinate of the content block\'s top-left corner on the page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Y' => ['description' => 'The y-coordinate of the content block\'s top-left corner on the page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'BeginTime' => ['description' => 'The start timestamp of the content block.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'EndTime' => ['description' => 'The end timestamp of the content block.', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of content blocks within this section.', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => 'A list of generated introductions for each part of the book.', 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage details for the request.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Book Introduction (Extract Book Selling Points / Book Summary)', 'changeSet' => [ ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunBookIntroduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'RunBookSmartCard' => [ 'summary' => 'A smart card interface for books.', 'path' => '/miaodu/stream/runBookSmartCard', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'Document ID.', 'type' => 'string', 'required' => true, 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'finished', 'title' => ''], 'EventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '1a0e898717105546647125853d4f54', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output object.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Card title.', 'type' => 'string', 'example' => '卡片标题内容', 'title' => ''], 'Tags' => [ 'description' => 'Array of card tags.', 'type' => 'array', 'items' => ['description' => 'Card tag.', 'type' => 'string', 'example' => '卡片标签内容', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Intelligent Book Card', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunBookSmartCard', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunCommentGeneration' => [ 'summary' => 'Predicts user comments for a specified article.', 'path' => '/quanmiao/aimiaobi/runCommentGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Path parameter. The unique identifier of your Alibaba Cloud Model Studio workspace. To get this ID, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-3kcs1w3lltrtbfkr', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], [ 'name' => 'Length', 'in' => 'formData', 'schema' => ['description' => 'Length of each comment in characters.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'NumComments', 'in' => 'formData', 'schema' => ['description' => 'Number of comments to generate.', 'type' => 'string', 'required' => true, 'example' => '10', 'title' => ''], ], [ 'name' => 'Style', 'in' => 'formData', 'schema' => ['description' => 'Tone of the comments.', 'type' => 'string', 'required' => false, 'example' => '积极正面'."\n", 'title' => ''], ], [ 'name' => 'SourceMaterial', 'in' => 'formData', 'schema' => ['description' => 'Article to comment on.', 'type' => 'string', 'required' => true, 'example' => 'ps5是sony新一代的游戏机，他创新性的...'."\n", 'title' => ''], ], [ 'name' => 'AllowEmoji', 'in' => 'formData', 'schema' => ['description' => 'Set to true to allow emoji in comments. Default is false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'Comment type.'."\n" ."\n" .'Valid keys:'."\n" ."\n" .'- emotion (expresses emotion)'."\n" ."\n" .'- opinion (states an opinion)'."\n" ."\n" .'- interaction (encourages interaction)'."\n" ."\n" .'- experience (shares experience)'."\n" ."\n" .'- humor (uses humor)', 'type' => 'object', 'required' => true, 'example' => '{"emotion":"50","opinion":"50"}'."\n", 'title' => ''], ], [ 'name' => 'Sentiment', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'Sentiment distribution.'."\n" ."\n" .'Valid keys:'."\n" ."\n" .'- positive'."\n" ."\n" .'- neutral'."\n" ."\n" .'- negative', 'type' => 'object', 'required' => true, 'example' => '{"positive":"50","negative":"50"}'."\n", 'title' => ''], ], [ 'name' => 'LengthRange', 'in' => 'formData', 'style' => 'json', 'schema' => ['description' => 'Length distribution.'."\n" ."\n" .'Valid keys:'."\n" ."\n" .'- short (up to 20 characters)'."\n" ."\n" .'- medium (20–50 characters)'."\n" ."\n" .'- long (50–100 characters)', 'type' => 'object', 'required' => true, 'example' => '{"short":"50","long":“50”}'."\n", 'title' => ''], ], [ 'name' => 'ExtraInfo', 'in' => 'formData', 'schema' => ['description' => 'Additional instructions.', 'type' => 'string', 'required' => false, 'example' => '不要输出额外其他信息'."\n", 'title' => ''], ], [ 'name' => 'ModelId', 'in' => 'formData', 'schema' => ['description' => 'ID of the model to use.', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'End' => ['description' => 'Indicates whether the response is complete.', 'type' => 'boolean', 'title' => '', 'example' => ''], 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'Event' => ['description' => 'Event name.', 'type' => 'string', 'example' => 'result-generated'."\n", 'title' => ''], 'EventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '可空'."\n", 'title' => ''], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '0bd58ea2-dc38-45da-ac02-17f05cb9040b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output data.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'Generated comment text.', 'type' => 'string', 'example' => '评论内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"End\\": false,\\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' => 'Customer Voice Prediction', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunCommentGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunContinueContent' => [ 'summary' => 'Continues generating content.', 'path' => '/quanmiao/aimiaobi/runContinueContent', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for the Alibaba Cloud Model Studio workspace. For more information, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content to continue.', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际，开发政务社交媒体的特色功能，如在线咨询服务、政策解读、互动问答等，增强政务社交媒体的互动性和实用性，提升公众参与度。'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'End' => ['title' => '', 'description' => 'Is output complete? True indicates completion.', 'type' => 'boolean', 'example' => ''], 'Header' => [ 'description' => 'Streaming output header, contains general return information.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Abnormal error code.', 'type' => 'string', 'example' => '403'], 'ErrorMessage' => ['title' => '', 'description' => 'Abnormal error message.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.'], 'Event' => ['title' => '', 'description' => 'Event type.', 'type' => 'string', 'example' => 'result-generated'], 'EventInfo' => ['title' => '', 'description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件'], 'SessionId' => ['title' => '', 'description' => 'Session ID.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'], 'TaskId' => ['title' => '', 'description' => 'Generation task ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], 'TraceId' => ['title' => '', 'description' => 'Trace ID.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Payload of the returned result, JSON structure.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output content object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Output content.', 'type' => 'string', 'example' => '这是测试输出'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Large Language Model (LLM) token usage information.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'OutputTokens' => ['title' => '', 'description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'TotalTokens' => ['title' => '', 'description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"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' => 'Content Completion', 'changeSet' => [ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunContinueContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunCustomHotTopicAnalysis' => [ 'summary' => 'Analyzes custom hot topics.', 'path' => '/quanmiao/miaoce/runCustomHotTopicAnalysis', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'AskUser', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The follow-up question from the model.', 'type' => 'string', 'example' => '模型反问', 'required' => false], ], [ 'name' => 'UserBack', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The user\'s input in response to the model\'s follow-up question.', 'type' => 'string', 'example' => '用户针对模型反问的输入', 'required' => false], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The user\'s input prompt.', 'type' => 'string', 'required' => true, 'example' => '用户输入Prompt'], ], [ 'name' => 'ForceAnalysisExistsTopic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to forcibly analyze a duplicate topic and overwrite the existing analysis.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID for each request.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID for the entire conversation task.'."\n" ."\n" .'> By default, you do not need to specify TaskId. The system automatically generates one. If you specify the same TaskId for subsequent tasks, the tasks are considered part of the same conversation group.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'CustomHoTTopicBaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'The Server-Sent Events (SSE) event. Valid values: task-started: The task starts. task-finished: The task is complete. task-failed: The task failed.', 'type' => 'string', 'example' => 'task-started'], 'OriginSessionId' => ['title' => '', 'description' => 'The parent session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'The session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'The trace ID.', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output.', 'title' => '', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The reference articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The article object.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容'], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID'], 'DocUuid' => ['title' => '', 'description' => 'The internal unique ID of the document.', 'type' => 'string', 'example' => 'a2103fcfbd5441f1991c72f8834833e3'], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-08-27 14:50:47'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网'], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要'], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '文章标签'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'AskUser' => [ 'description' => 'The list of follow-up questions.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The follow-up question from the model.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'example' => '', ], 'AsyncTaskId' => ['title' => '', 'description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => '异步任务ID'], 'Attitude' => ['title' => '', 'description' => 'The custom perspective for topic selection.', 'type' => 'string', 'example' => '自定义选题视角'], 'SearchQuery' => ['title' => '', 'description' => 'The rewritten query.', 'type' => 'string', 'example' => '大模型改变世界'], 'Text' => ['title' => '', 'description' => 'The text generation result.', 'type' => 'string', 'example' => '文本生成结果'], 'TopicId' => ['title' => '', 'description' => 'The topic ID.', 'type' => 'string', 'example' => '话题ID'], ], 'example' => '', ], 'Usage' => [ 'description' => 'The token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of tokens used for the input.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], 'OutputTokens' => ['description' => 'The number of tokens for the output.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '73', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Custom Hot Spot Topic Analysis ', 'changeSet' => [ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunCustomHotTopicAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunCustomHotTopicViewPointAnalysis' => [ 'summary' => 'Perspective analysis of custom topics.', 'path' => '/quanmiao/miaoce/runCustomHotTopicViewPointAnalysis', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get the Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'AskUser', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Model follow-up question', 'type' => 'string', 'example' => '模型反问', 'required' => false], ], [ 'name' => 'UserBack', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'User feedback', 'type' => 'string', 'example' => '用户反馈', 'required' => false], ], [ 'name' => 'SearchQuery', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Rewritten query', 'type' => 'string', 'example' => '改写后的Query', 'required' => false], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Prompt for custom hot topic viewpoint analysis', 'type' => 'string', 'required' => true, 'example' => '自定义选题视角的Prompt'], ], [ 'name' => 'SkipAskUser', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Set to true to skip the follow-up question', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'TopicId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot topic ID', 'type' => 'string', 'example' => '热点主题ID', 'required' => false], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The hot topic for analysis', 'type' => 'string', 'example' => '热点主题', 'required' => false], ], [ 'name' => 'TopicVersion', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot topic version', 'type' => 'string', 'example' => '热点主题版本', 'required' => false], ], [ 'name' => 'TopicSource', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Hot topic source', 'type' => 'string', 'example' => '热点主题来源', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'CustomHotTopicBaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'Server-sent event. Valid values: task-started, task-finished, and task-failed.', 'type' => 'string', 'example' => 'task-started'], 'OriginSessionId' => ['title' => '', 'description' => 'Parent session ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'Session ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'Trace ID', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs', 'title' => '', 'type' => 'object', 'properties' => [ 'AskUser' => [ 'description' => 'Follow-up question list', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Model follow-up question', 'type' => 'string', 'example' => 'xxxxxxx', 'title' => ''], 'example' => '', ], 'AsyncTaskId' => ['title' => '', 'description' => 'Asynchronous task ID', 'type' => 'string', 'example' => '异步任务ID'], 'Attitude' => ['title' => '', 'description' => 'Viewpoint of the custom hot topic generated by the model', 'type' => 'string', 'example' => '模型生成的自定义选题视角的观点'], 'CustomViewPointId' => ['description' => 'Custom viewpoint ID', 'type' => 'string', 'example' => 'xxxxxx', 'title' => ''], 'Text' => ['title' => '', 'description' => 'Text generation result', 'type' => 'string', 'example' => '文本生成结果'], 'TopicId' => ['title' => '', 'description' => 'Topic ID', 'type' => 'string', 'example' => '话题ID'], 'Articles' => [ 'description' => 'Reference article list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Reference article object', 'title' => '', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '作者'."\n" ."\n"], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '文章标题'], 'Content' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'example' => '文章内容'], 'PubTime' => ['title' => '', 'description' => 'Publish time', 'type' => 'string', 'example' => '2024-09-10 14:17:53'], 'Source' => ['title' => '', 'description' => 'Source', 'type' => 'string', 'example' => '央视网'], 'Url' => ['title' => '', 'description' => 'URL title.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => '文章摘要'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'Usage' => [ 'description' => 'Whether the image is running on an ECS instance. Valid values:'."\n" ."\n" .'- instance: The image is running and used by an ECS instance.'."\n" ."\n" .'- none: The image is idle and not currently used by any ECS instance.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '51', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '79', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '130', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Custom Subject Perspective Analysis', 'changeSet' => [ ['createdAt' => '2025-05-13T10:07:25.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunCustomHotTopicViewPointAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunDeepWriting' => [ 'summary' => 'Queries deep writing events. The system returns detailed information about the task execution as a stream of Server-Sent Events (SSE).', 'path' => '/pop/deepWrite/runDeepWriting', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-ir8zkqry2fncaxwq', 'title' => ''], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The task ID.', 'type' => 'string', 'required' => false, 'example' => '95c2fbe6-5a20-4fc2-8a93-376ed05fbe13', 'title' => ''], ], [ 'name' => 'Cursor', 'in' => 'formData', 'schema' => ['description' => 'The cursor, which is the ordinal number of the streaming event.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '403', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '错误消息', 'title' => ''], 'Event' => [ 'description' => 'The Server-Sent Event (SSE).', 'enumValueTitles' => ['response.sub_task.created' => 'The subtask is created.', 'response.output_item.done' => 'The intermediate result is generated.', 'response.completed' => 'The task is complete.', 'response.created' => 'The task is created.'], 'type' => 'string', 'example' => 'response.output_item.done', 'title' => '', ], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'c2e2e991-f96a-4fcc-9ff7-d0df46c6d232', 'title' => ''], 'StatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'b84d31a5-44b2-4a35-9c6d-878d459c93d0', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => 'FAB10D42-F081-557B-8DCB-D6FB7AAF100B', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'The type.', 'type' => 'string', 'example' => '同上级Event', 'title' => ''], 'SequenceNumber' => ['description' => 'The ordinal number of the streaming event.', 'type' => 'string', 'example' => '1', 'title' => ''], 'OutputIndex' => ['description' => 'The ordinal number of the new output item in this event.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Response' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The unique ID of the task.', 'type' => 'string', 'example' => 'b2dc224b38694e0b668020159a7c5732', 'title' => ''], 'Status' => [ 'description' => 'The execution status of the task.', 'enumValueTitles' => ['in_progress' => 'The task is in progress.', 'completed' => 'The task is complete.'], 'type' => 'string', 'example' => 'in_progress', 'title' => '', ], ], 'title' => '', 'example' => '', ], 'Item' => [ 'description' => 'The new output item for this event.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The unique ID of the item.', 'type' => 'string', 'example' => '88f6ed9e85c4f9377378da23e6a370d1', 'title' => ''], 'Status' => [ 'description' => 'The status of the item.', 'enumValueTitles' => ['in_progress' => 'In progress.', 'completed' => 'Complete.'], 'type' => 'string', 'example' => 'completed', 'title' => '', ], 'Type' => [ 'description' => 'The type of the item.', 'enumValueTitles' => ['function_call' => 'A function call.', 'message' => 'A message.'], 'type' => 'string', 'example' => 'function_call', 'title' => '', ], 'Arguments' => ['description' => 'Parameter', 'type' => 'string', 'example' => 'item类型为function_call时，此字段有值，为调用函数的入参', 'title' => ''], 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'item类型为function_call时，此字段有值，为调用的函数名字', 'title' => ''], 'Result' => ['description' => 'The item\'s result.', 'type' => 'string', 'example' => 'item类型为function_call时，此字段有值，为调用的函数的输出', 'title' => ''], 'Agent' => ['description' => 'The name of the agent that generated this item.', 'type' => 'string', 'example' => 'ProjectManager', 'title' => ''], 'Content' => [ 'description' => 'This field has a value when the item type is \\`message\\`. The value is a list of output content.', 'type' => 'array', 'items' => [ 'description' => 'The text content.', 'type' => 'object', 'properties' => [ 'Type' => ['description' => 'When the item type is \\`message\\`, the value of this field is \\`output\\_text\\`.', 'type' => 'string', 'example' => 'output_text', 'title' => ''], 'Text' => ['description' => 'The text content that is output when the item type is \\`message\\`.', 'type' => 'string', 'example' => '', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => '31AC01F1-88FB-5C4D-B6F5-E8BB136CD5A3', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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\\": \\"\\"\\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' => 'Query deep writing management events ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunDeepWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunDocBrainmap' => [ 'summary' => 'Generate a three-level, multilingual mind map from an article or a book, with control over the number of second-level nodes and the word count of leaf nodes.', 'path' => '/miaodu/stream/runDocBrainmap', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The ID of the Model Studio workspace. For more information, see [How to use a workspace](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'A custom prompt to guide the mind map generation.', 'type' => 'string', 'example' => '请按英文输出', 'required' => false, 'title' => ''], ], [ 'name' => 'CleanCache', 'in' => 'formData', 'schema' => ['description' => 'Indicates whether to clear the previous cache.', 'type' => 'boolean', 'example' => 'true', 'required' => false, 'title' => ''], ], [ 'name' => 'NodeNumber', 'in' => 'formData', 'schema' => ['description' => 'The number of nodes to generate at the second level of the mind map.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'required' => false, 'title' => ''], ], [ 'name' => 'WordNumber', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of words in each node.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false, 'title' => ''], ], [ 'name' => 'referenceContent', 'in' => 'formData', 'schema' => ['description' => 'The source content for generating the mind map. This parameter takes precedence over `DocId`.', 'type' => 'string', 'example' => '要生成脑图的内容', 'required' => false, 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'The name of the model to use.', 'type' => 'string', 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'required' => false, 'title' => ''], ], [ 'name' => 'ResponseFormat', 'in' => 'formData', 'schema' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'task-failed', 'title' => ''], 'EventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '07181f55-2311-48af-8048-132a77dee020', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '161816', 'title' => ''], 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '6427cdf4-2ffe-4d05-b0ef-c4adceea90f4', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response payload.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output data.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Mind map content in JSON format.', 'type' => 'string', 'example' => '{"xxxx":"xxx"}', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage statistics.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '65', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '165', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Full-text mind map ', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-04-17T03:26:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocBrainmap', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'RunDocIntroduction' => [ 'summary' => 'Generates a summary for an article, video, or URL, including a full-text summary, key points, and a chapter overview (i.e., segmented content with summaries and abstracts for each segment). It also supports multilingual input and output. If the user only requires a full-text summary of an article, they can use the RunDocSummary API. For details, see 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' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier (UUID) of the Alibaba Cloud Model Studio workspace. For more information, see [Workspace ID](~~2587495~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'Document ID', 'type' => 'string', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Conversation ID', 'type' => 'string', 'required' => true, 'example' => 'a3b5eb35-6b28-4cf9-ac09-1dec25ab4df6', 'title' => ''], ], [ 'name' => 'SummaryPrompt', 'in' => 'formData', 'schema' => ['description' => 'Custom requirements for the summary content', 'type' => 'string', 'required' => false, 'example' => '用英文输出', 'title' => ''], ], [ 'name' => 'KeyPointPrompt', 'in' => 'formData', 'schema' => ['description' => 'Custom requirements for key points', 'type' => 'string', 'required' => false, 'example' => '用英文输出', 'title' => ''], ], [ 'name' => 'IntroductionPrompt', 'in' => 'formData', 'schema' => ['description' => 'Custom requirements for the document summary', 'type' => 'string', 'required' => false, 'example' => '用英文输出', 'title' => ''], ], [ 'name' => 'CleanCache', 'in' => 'formData', 'schema' => ['description' => 'Purge cache', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'referenceContent', 'in' => 'formData', 'schema' => ['description' => 'Content to generate the summary from. If not empty, this value takes precedence over docId.', 'type' => 'string', 'required' => false, 'example' => '要进行导读的内容', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['type' => 'string', 'description' => 'User-defined model name', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'response header', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'error code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Type of management event', 'type' => 'string', 'example' => 'task-started', 'title' => ''], 'EventInfo' => ['description' => 'Description of the management event', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'session ID', 'type' => 'string', 'example' => '20247a52-23e2-46fb-943d-309cdee2bc6d', 'title' => ''], 'TaskId' => ['description' => 'Job ID', 'type' => 'string', 'example' => '8a9cecb7-6d20-32db-8823-5882c217b647', 'title' => ''], 'TraceId' => ['description' => 'End-to-end trace ID', 'type' => 'string', 'example' => '0bd58ea2-dc38-45da-ac02-17f05cb9040b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'response body', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs ', 'type' => 'object', 'properties' => [ 'Introductions' => [ 'description' => 'Array of segment introductions ', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Blocks' => [ 'description' => 'Array of position information ', 'type' => 'array', 'items' => [ 'description' => 'Position information ', 'type' => 'object', 'properties' => [ 'Height' => ['description' => 'Height of the text block ', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'PageId' => ['description' => 'Page number where the text block is located ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Width' => ['description' => 'Width of the text block', 'type' => 'integer', 'format' => 'int32', 'example' => '600', 'title' => ''], 'X' => ['description' => 'X coordinate of the top-left corner of the block ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Y' => ['description' => 'Y coordinate of the top-left corner of the block ', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'BeginTime' => ['description' => 'Start Time of the segment ', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], 'EndTime' => ['description' => 'End Time of the segment ', 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'StartPageId' => ['description' => 'Starting page number of multiple text blocks', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Summary' => ['description' => 'Summary of this segment', 'type' => 'string', 'example' => '本段摘要内容', 'title' => ''], 'Title' => ['description' => 'Title of this segment', 'type' => 'string', 'example' => '本段标题内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'KeyPoint' => ['description' => 'Key point content ', 'type' => 'string', 'example' => '要点1；要点2；', 'title' => ''], 'Summary' => ['description' => 'Outline summary ', 'type' => 'string', 'example' => '大纲摘要内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'token usage', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Input token quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Output token quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total token quantity ', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID', 'title' => '', 'type' => 'string', 'example' => 'C9B5BEA6-E8C4-5861-BE37-D906D516510E'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Document Summary', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-04-17T03:26:54.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocIntroduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'RunDocQa' => [ 'summary' => 'Article Q&A: For a natural language query, provide a textual answer within the specified article scope (accompanied by images if available) and display source attribution information. '."\n" .'Multimodal File Q&A: For a natural language query, provide a textual answer within the specified multimodal file scope, along with relevant images, video segments, or text, and display source attribution information. ', 'path' => '/miaodu/stream/runDocQA', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'abilityTreeNodes' => ['FEATUREsfmJIZ0TW'], ], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Alibaba Cloud Model Studio workspace ID. For details on how to obtain it, see [How to Use Workspaces](~~2587495~~). ', 'type' => 'string', 'required' => true, 'example' => 'llm-dswd4003ny4gh9rw', 'title' => ''], ], [ 'name' => 'SearchSource', 'in' => 'formData', 'schema' => [ 'enumValueTitles' => ['fromIndexLib' => 'Perform Q&A based on the entire document library ', 'fromWeb' => 'Perform Q&A based on web search ', 'fromRefContent' => 'Perform Q&A based on the ReferenceContent field', 'fromDoc' => 'Perform document Q&A based on the provided document ID '], 'description' => 'Search source ', 'type' => 'string', 'required' => true, 'example' => 'fromWeb', 'title' => '', ], ], [ 'name' => 'DocIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Array of multiple document IDs ', 'type' => 'array', 'items' => ['description' => 'Document ID ', 'type' => 'string', 'required' => false, 'example' => '10022', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['description' => 'Question ', 'type' => 'string', 'required' => true, 'example' => '苹果16手机什么时候发布', 'title' => ''], ], [ 'name' => 'ReferenceContent', 'in' => 'formData', 'schema' => ['description' => 'Associated content actively provided by the questioner ', 'type' => 'string', 'required' => false, 'example' => '关联内容', 'title' => ''], ], [ 'name' => 'ConversationContexts', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Array of historical context content ', 'type' => 'array', 'items' => [ 'description' => 'Historical context ', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Q&A pair content ', 'type' => 'string', 'required' => false, 'example' => '问答内容', 'title' => ''], 'Role' => ['description' => 'Role ', 'type' => 'string', 'required' => false, 'example' => 'user', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Conversation ID ', 'type' => 'string', 'required' => true, 'example' => 'f486c4e2-b773-4d65-88f8-2ba540610456', 'title' => ''], ], [ 'name' => 'CategoryIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Array of folder IDs for filtering. This parameter takes effect only when SearchSource is set to fromIndexLib. ', 'type' => 'array', 'items' => ['description' => 'Category ID ', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['type' => 'string', 'description' => 'Custom model name defined by the User ', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response ', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'response header ', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'error code ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'error message ', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'management event ', 'type' => 'string', 'example' => 'task-started', 'title' => ''], 'EventInfo' => ['description' => 'Description of the management event ', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID ', 'type' => 'string', 'example' => 'f5517ee8-dbec-4dc8-bd0a-af084b5e3db1', 'title' => ''], 'TaskId' => ['description' => 'Job ID ', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'End-to-end trace ID ', 'type' => 'string', 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'response body ', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Content of the response', 'type' => 'string', 'example' => '回答内容', 'title' => ''], 'InterveneContent' => ['description' => 'Response content after intervention ', 'type' => 'string', 'example' => '干预后的回答内容', 'title' => ''], 'IsReject' => ['description' => 'Indicates whether the request is rejected ', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'MediaUrlList' => [ 'description' => 'List of multimodal resource information', 'type' => 'array', 'items' => [ 'description' => 'Multimodal resource object', 'type' => 'object', 'properties' => [ 'ClipInfos' => [ 'description' => 'Array of related video time information', 'type' => 'array', 'items' => [ 'description' => 'Related video time information', 'type' => 'object', 'properties' => [ 'From' => ['description' => 'Start time of the video segment', 'type' => 'number', 'format' => 'double', 'example' => '0', 'title' => ''], 'To' => ['description' => 'End time of the video segment', 'type' => 'number', 'format' => 'double', 'example' => '30', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'FileUrl' => ['description' => 'File URL', 'type' => 'string', 'example' => 'https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg', 'title' => ''], 'MediaType' => ['description' => 'Media asset type', 'type' => 'string', 'example' => 'video', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Recommends' => [ 'description' => 'Array of recommended content ', 'type' => 'array', 'items' => [ 'description' => 'Recommended content ', 'type' => 'object', 'properties' => [ 'Title' => ['description' => 'Title of the recommended content ', 'type' => 'string', 'example' => '标题内容', 'title' => ''], 'Url' => ['description' => 'URL of the recommended content ', 'type' => 'string', 'example' => '推荐内容url', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'References' => [ 'description' => 'Array of sources for the response content', 'type' => 'array', 'items' => [ 'description' => 'Source of the response content', 'type' => 'object', 'properties' => [ 'PubTime' => ['description' => 'Published At', 'type' => 'string', 'example' => '2024-10-08 18:00', 'title' => ''], 'Source' => ['description' => 'Source ', 'type' => 'string', 'example' => '新浪新闻', 'title' => ''], 'SourceDocId' => ['description' => 'Source docId', 'type' => 'string', 'example' => '123456', 'title' => ''], 'Title' => ['description' => 'Title of the associated content', 'type' => 'string', 'example' => '标题内容', 'title' => ''], 'Url' => ['description' => 'Article URL ', 'type' => 'string', 'example' => 'http://xxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'token usage ', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Quantity of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Number of tokens used in the output', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID ', 'title' => '', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Document Q&A (Article Q&A / Multimodal File Q&A) ', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocQa', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'RunDocSmartCard' => [ 'summary' => 'Automatically adds tags to selected text or a specified chat and generates a smart card note.', 'path' => '/miaodu/stream/runDocSmartCard', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'The document ID.', 'type' => 'string', 'required' => true, 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'The session ID.', 'type' => 'string', 'required' => true, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'The prompt.', 'type' => 'string', 'required' => false, 'example' => '自定义提示词', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'The name of the custom model.', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Header' => [ 'description' => 'The response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'finished', 'title' => ''], 'EventInfo' => ['description' => 'The event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'The unique ID of the session.', 'type' => 'string', 'example' => '07181f55-2311-48af-8048-132a77dee020', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '8d55b429d7c6d321fcff54823e8d317b', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '0abb781c17337107444473701ed7c3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output object.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'The title of the card.', 'type' => 'string', 'example' => '标题内容', 'title' => ''], 'Tags' => [ 'description' => 'An array of card tags.', 'type' => 'array', 'items' => ['description' => 'A card tag.', 'type' => 'string', 'example' => '标签内容', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'The token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of tokens used for the input.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'The number of tokens for the output.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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\\": \\"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' => 'Document Mind Card', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-15T03:04:46.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocSmartCard', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunDocSummary' => [ 'summary' => 'Generates a summary of an article, video, or URL—that is, a concise overview of the entire content. It also supports multilingual input and output.', 'path' => '/miaodu/stream/runDocSummary', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Alibaba Cloud Model Studio workspace ID. For more information about how to obtain it, see [How to use a workspace](~~2587495~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Conversation ID', 'type' => 'string', 'required' => true, 'example' => '0f56f98a-f2d8-47ec-98e9-1cbdcffa9539', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'Document ID', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['description' => 'Custom requirements', 'type' => 'string', 'required' => false, 'example' => '请总结一下这篇文档', 'title' => ''], ], [ 'name' => 'RecommendContent', 'in' => 'formData', 'schema' => ['description' => 'Content to be summarized', 'type' => 'string', 'required' => false, 'example' => '要总结的内容', 'title' => ''], ], [ 'name' => 'CleanCache', 'in' => 'formData', 'schema' => ['description' => 'Purge the current cache', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'Custom model name specified by the User', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'response header', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'error code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'error message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Type of management event', 'type' => 'string', 'example' => 'task-started', 'title' => ''], 'EventInfo' => ['description' => 'Description of the management event', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'session ID', 'type' => 'string', 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df', 'title' => ''], 'TaskId' => ['description' => 'Job ID', 'type' => 'string', 'example' => 'b057f2fa-2277-477b-babf-cbc062307828', 'title' => ''], 'TraceId' => ['description' => 'End-to-end trace ID', 'type' => 'string', 'example' => '2150451a17191950923411783e2927', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'response body', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Summary content', 'type' => 'string', 'example' => '总结内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'LLM token usage information', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Quantity of tokens used in the input', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Request ID', 'title' => '', 'type' => 'string', 'example' => '3259D344-E871-5DE0-8FFE-CDA21F8D4382'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Document summary', 'changeSet' => [ ['createdAt' => '2025-05-27T11:04:18.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocSummary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'RunDocTranslation' => [ 'summary' => 'An API for document translation between English and Chinese.', 'path' => '/miaodu/stream/runDocTranslation', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Alibaba Cloud Model Studio workspace unique identifier. For more information, see [Get the Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Session ID', 'type' => 'string', 'required' => true, 'example' => '2e6b3987-f743-4d4c-8326-d9c41a6af3ee', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'Document ID', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ 'name' => 'TransType', 'in' => 'formData', 'schema' => ['description' => 'Translation type', 'type' => 'string', 'required' => false, 'example' => 'toChinese'."\n" .'toEnglish'."\n" .'toJapenese'."\n" .'toRussian'."\n" .'toFrench'."\n" .'toGerman'."\n" .'toItalian'."\n" .'toKorean'."\n" .'toSpanish'."\n" .'toPortuguese', 'title' => ''], ], [ 'name' => 'RecommendContent', 'in' => 'formData', 'schema' => ['description' => 'Content to be translated', 'type' => 'string', 'required' => false, 'example' => '要翻译的内容', 'title' => ''], ], [ 'name' => 'CleanCache', 'in' => 'formData', 'schema' => ['description' => 'Clear the current cache?', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'User-defined model name', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'ErrorMessage' => ['description' => 'Error code message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Event type', 'type' => 'string', 'example' => 'task-started', 'title' => ''], 'EventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '411c4dfa-2168-4379-a902-675d67f453f8', 'title' => ''], 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '50a1cc8e-717e-4a2b-a76b-dc9734a8564b', 'title' => ''], 'TraceId' => ['description' => 'Trace ID', 'type' => 'string', 'example' => 'ebd19b12-0cae-488f-9e41-5a1c825f545b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Translated content', 'type' => 'string', 'example' => '翻译内容', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of tokens used for input', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Number of tokens used for output', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens used for this call', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Document Translation', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-13T12:10:31.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocTranslation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'RunDocWashing' => [ 'summary' => 'Rewrites an article in a specified style.', 'path' => '/quanmiao/aimiaobi/runDocWashing', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier for Alibaba Cloud Model Studio workspace: Get [Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Channel ID', 'type' => 'string', 'required' => false, 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], [ 'name' => 'WritingTypeName', 'in' => 'formData', 'schema' => ['description' => 'Writing style type name', 'type' => 'string', 'required' => false, 'example' => '小红书文体'."\n" .'朋友圈文体'."\n" .'专业新闻文体'."\n" .'政府公文文体'."\n" .'报纸文章文体'."\n" .'意见信文体', 'title' => ''], ], [ 'name' => 'WritingTypeRefDoc', 'in' => 'formData', 'schema' => ['description' => 'Example article for writing style', 'type' => 'string', 'required' => false, 'example' => '该值若不为空则按该值优先', 'title' => ''], ], [ 'name' => 'ReferenceContent', 'in' => 'formData', 'schema' => ['description' => 'The article to rewrite', 'type' => 'string', 'required' => true, 'example' => '文章内容', 'title' => ''], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['description' => 'Topic of the rewritten article', 'type' => 'string', 'required' => false, 'example' => '云南旅游主题', 'title' => ''], ], [ 'name' => 'WordNumber', 'in' => 'formData', 'schema' => ['description' => 'Required word count after rewriting', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'Additional prompt requirements', 'type' => 'string', 'required' => false, 'example' => '按英文输出', 'title' => ''], ], [ 'name' => 'ModelId', 'in' => 'formData', 'schema' => ['description' => 'Model ID', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'End' => ['description' => 'Is the response package finished?', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'Header' => [ 'description' => 'Response header', 'type' => 'object', 'properties' => [ 'Event' => ['description' => 'Event type', 'type' => 'string', 'example' => 'task-finished', 'title' => ''], 'EventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '20247a52-23e2-46fb-943d-309cdee2bc6d', 'title' => ''], 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'Full link ID', 'type' => 'string', 'example' => '2150451a17191950923411783e2927', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'Output content', 'type' => 'string', 'example' => '文本生成结果', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token consumption', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Rewrite', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocWashing', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunExpandContent' => [ 'summary' => 'Expands content.', 'path' => '/quanmiao/aimiaobi/runExpandContent', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Alibaba Cloud Model Studio workspace unique identifier. Get the [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content to expand.', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际，开发政务社交媒体的特色功能，如在线咨询服务、政策解读、互动问答等，增强政务社交媒体的互动性和实用性，提升公众参与度。'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom prompt.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'End' => ['title' => '', 'description' => 'Whether the output is complete. True indicates completion.', 'type' => 'boolean', 'example' => ''], 'Header' => [ 'description' => 'Streaming output header, containing general return information.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code for exceptions.', 'type' => 'string', 'example' => '403'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message for exceptions.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.'], 'Event' => ['title' => '', 'description' => 'Event type.', 'type' => 'string', 'example' => 'result-generated'], 'EventInfo' => ['title' => '', 'description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件'], 'SessionId' => ['title' => '', 'description' => 'Session ID for a single session.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'], 'TaskId' => ['title' => '', 'description' => 'Task ID for a single generation task.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], 'TraceId' => ['title' => '', 'description' => 'Trace ID for the link.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Payload of the returned result, JSON structure.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output content object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Output content.', 'type' => 'string', 'example' => '这是测试输出'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Large Language Model (LLM) token usage information.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'OutputTokens' => ['title' => '', 'description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'TotalTokens' => ['title' => '', 'description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"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' => 'Content Expansion', 'changeSet' => [ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunExpandContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunGenerateQuestions' => [ 'summary' => 'Submits a query and returns several related queries.', 'path' => '/miaodu/stream/runGenerateQuestions', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-w335gauzlbba2vze', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Session ID', 'type' => 'string', 'required' => false, 'example' => 'f486c4e2-b773-4d65-88f8-2ba540610456', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'Document ID', 'type' => 'string', 'required' => false, 'example' => 'oOgIwodFANW1u5MnqxysOh1rtld3xn', 'title' => ''], ], [ 'name' => 'ReferenceContent', 'in' => 'formData', 'schema' => ['description' => 'Document content to extract questions from. If this field is not empty, use this text. If it is empty, use the document identified by DocId.', 'type' => 'string', 'required' => false, 'example' => '关联内容', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'Name of the custom model', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Header' => [ 'description' => 'Response header', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => 'RateLimit', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message returned when the call fails.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Event name', 'type' => 'string', 'example' => 'finished', 'title' => ''], 'EventInfo' => ['description' => 'Event description', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035', 'title' => ''], 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99', 'title' => ''], 'TraceId' => ['description' => 'Trace ID', 'type' => 'string', 'example' => '0bc3b4b417362160345997589e5f6e', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Question content', 'type' => 'string', 'example' => '问题1\\n问题2\\n问题3\\n', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens used', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Questions You Might Want to Ask ', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunGenerateQuestions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunHotword' => [ 'summary' => 'Extract keywords from a specified document. Keywords are domain-specific professional terms or concepts that represent and identify a particular industry or field. They accurately describe and summarize the core content, key people, major events, or technical terms in that domain.', 'path' => '/miaodu/stream/runHotword', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-baw8as25ll3wnzjr', 'title' => ''], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => false, 'example' => 'e32a1a3f-1f7e-41dd-b888-ef1d91b96d1e', 'title' => ''], ], [ 'name' => 'DocId', 'in' => 'formData', 'schema' => ['description' => 'Document ID.', 'type' => 'string', 'required' => false, 'example' => '84ufBYEeLMZOjRFo84HJ7ySL3Efr55', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'Prompt.', 'type' => 'string', 'required' => false, 'example' => '提示词', 'title' => ''], ], [ 'name' => 'ReferenceContent', 'in' => 'formData', 'schema' => ['description' => 'Document content to extract hotwords from. If not empty, extract hotwords from this content. If empty, extract hotwords using the DocId.', 'type' => 'string', 'required' => false, 'example' => '关联内容', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'Name of the custom model.', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Event' => ['description' => 'Event type.', 'type' => 'string', 'example' => 'finished', 'title' => ''], 'EventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '0abb7e3217356108993888059ee72b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output.', 'type' => 'object', 'properties' => [ 'Content' => ['description' => 'Hotword content.', 'type' => 'string', 'example' => '全球影响,文化交流,孙悟空,动画改编', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Extract Keywords', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunHotword', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunKeywordsExtractionGeneration' => [ 'summary' => 'Extracts and generates keywords using AMB.', 'path' => '/quanmiao/aimiaobi/runKeywordsExtractionGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier for the Alibaba Cloud Model Studio workspace. Obtain the [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Data required for generation.', 'type' => 'object', 'properties' => [ 'Contents' => [ 'description' => 'List of content.', 'type' => 'array', 'items' => ['description' => 'Content.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier for the associated creation article.'."\n" ."\n" .'> TaskId is not required by default; the system automatically generates it. If subsequent tasks use the same TaskId, they belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom prompt.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'AccessForbid', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Event' => ['description' => 'SSE event.', 'type' => 'string', 'example' => 'task-failed', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '1a3d7c9f-3a6d-4e49-b176-2d8721a27397', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '8d55b429d7c6d321fcff54823e8d317b', 'title' => ''], 'TraceId' => ['description' => 'Trace ID.', 'type' => 'string', 'example' => '210bc4e817219607963985396de8bd', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'Text generation result.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens used in this call.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Unique request identifier.', 'type' => 'string', 'example' => '419F3FBE-5C8D-5949-AC29-E9615235D15A', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Keyword Extraction ', 'changeSet' => [ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunKeywordsExtractionGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunMultiDocIntroduction' => [ 'summary' => 'Generate an outline-style summary for multiple documents, videos, or URLs. The summary includes a consolidated overview and key points. This operation supports multiple input and output languages.', 'path' => '/miaodu/stream/runMultiDocIntroduction', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd', 'title' => ''], ], [ 'name' => 'DocIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Array of document IDs.', 'type' => 'array', 'items' => ['description' => 'Document ID.', 'type' => 'string', 'required' => false, 'example' => '10022', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['description' => 'Session ID.', 'type' => 'string', 'required' => true, 'example' => '75bf82fa-b71b-45d7-ae40-0b00e496cd9e', 'title' => ''], ], [ 'name' => 'SummaryPrompt', 'in' => 'formData', 'schema' => ['description' => 'Custom prompt for the summary.', 'type' => 'string', 'required' => false, 'example' => '请简明扼要', 'title' => ''], ], [ 'name' => 'KeyPointPrompt', 'in' => 'formData', 'schema' => ['description' => 'Custom prompt for key points.', 'type' => 'string', 'required' => false, 'example' => '请简明扼要', 'title' => ''], ], [ 'name' => 'ModelName', 'in' => 'formData', 'schema' => ['description' => 'Name of the custom model to use.', 'type' => 'string', 'required' => false, 'example' => 'quanmiao-max、quanmiao-plus'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'Message does not exist.', 'title' => ''], 'Event' => ['description' => 'Server-sent event (SSE) type.', 'type' => 'string', 'example' => 'finished', 'title' => ''], 'EventInfo' => ['description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '92e16ccb-92b6-4894-abbf-fc6e2929a0df', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => 'b057f2fa-2277-477b-babf-cbc062307828', 'title' => ''], 'TraceId' => ['description' => 'End-to-end trace ID.', 'type' => 'string', 'example' => '46e5c2b5-0877-4f09-bd91-ab0cf314e48b', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output data.', 'type' => 'object', 'properties' => [ 'Summary' => ['description' => 'Outline-style summary.', 'type' => 'string', 'example' => '大纲摘要内容', 'title' => ''], 'KeyPoints' => [ 'description' => 'Key point information.', 'type' => 'array', 'items' => [ 'description' => 'Key point information.', 'type' => 'object', 'properties' => [ 'KeyPoint' => ['description' => 'Key point.', 'type' => 'string', 'example' => '关键点信息', 'title' => ''], 'Source' => ['description' => 'Source of the information.', 'type' => 'string', 'example' => '信息来源', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '65', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '165', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Multi-document aggregation summary', 'changeSet' => [ ['createdAt' => '2025-06-25T11:43:15.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunMultiDocIntroduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunPptOutlineGeneration' => [ 'path' => '/pop/ppt/runPptOutlineGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-8v8a5mfpxffrj1pn', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The user\'s prompt.', 'type' => 'string', 'required' => true, 'example' => '帮我生成一个消防安全主题的PPT'], ], [ 'name' => 'ExternalUserId', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'abc', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Success', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Event' => ['description' => 'The SSE event. \\`task-started\\`: The task starts. \\`task-finished\\`: The task is complete. \\`task-failed\\`: The task failed.', 'type' => 'string', 'example' => 'task-started', 'title' => ''], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '1a3d7c9f-3a6d-4e49-b176-2d8721a27397', 'title' => ''], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '8996314ce5514867943c71935e6a45af', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '0bc1ec3a17435601877224179ecc8a', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The output content.', 'type' => 'string', 'example' => '文本生成结果', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Message' => ['description' => 'The message.', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\`: The request was successful. \\`false\\`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Generate PPT outline content ', 'summary' => 'Generates a PowerPoint outline.', 'description' => 'Instructions:'."\n" ."\n" .'- This API uses the HTTP Server-Sent Events (SSE) protocol.'."\n" ."\n" .'- You cannot test this API directly in the OpenAPI Portal because the portal is not compatible with the SSE inference protocol. For examples of how to call the API using the SDK for Java or Python, see [PPT Generation Best practices](https://help.aliyun.com/en/model-studio/ppt-generation-best-practices).'."\n" ."\n" .'- To obtain the latest version of the asynchronous Java SDK, [click this link](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' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunPptOutlineGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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"}]', 'translator' => 'machine', ], 'RunQuickWriting' => [ 'summary' => 'Enter writing instructions to quickly generate content.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Task ID. Reuse the same task ID for multi-turn conversations.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'Articles', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Referenced articles', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Article object', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'Article title', 'type' => 'string', 'required' => false, 'example' => '文章标题'], 'Content' => ['title' => '', 'description' => 'Article content', 'type' => 'string', 'required' => false, 'example' => '文章内容'], 'Url' => ['title' => '', 'description' => 'Article URL', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'], ], 'required' => false, 'example' => '文章对象'."\n", ], 'required' => false, 'example' => '集合', ], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Other writing parameters. Choose either prompt or writingParams.', 'type' => 'string', 'required' => true, 'example' => '请按英文输出'], ], [ 'name' => 'SearchSources', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Use the specified search source list.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search source object', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'SystemSearch: system-built-in search. CustomSemanticSearch: custom semantic index search. ThirdSearch: third-party API search.', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch'], 'DatasetName' => ['title' => '', 'description' => 'Unique identifier of the data source', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'SSE event. task-started: started, task-finished: finished, task-failed: failed.', 'type' => 'string', 'example' => 'task-started'], 'SessionId' => ['title' => '', 'description' => 'Session ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'StatusCode' => ['title' => '', 'description' => 'HTTP response code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'Trace ID', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Text generation result', 'type' => 'string', 'example' => '文本生成结果'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Token usage information', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens used', 'type' => 'integer', 'format' => 'int64', 'example' => '78', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '38', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'End' => ['description' => 'Indicates whether the response package has ended.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Quick Writing', 'description' => '### Access Instructions:'."\n" ."\n" .'- The OpenAPI portal is incompatible with the Server-Sent Events (SSE) inference protocol. Therefore, you cannot directly debug this operation. For an example of how to call the API using an SDK, see [Miaobi Best Practices](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" ."\n" .'- Click this [link](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?version=2023-08-01\\&language=java-async-tea\\&tab=primer-doc) to download the latest version of the Java asynchronous SDK.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunQuickWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunSearchGeneration' => [ 'summary' => 'AI Miaosou – Intelligent Search Generation: This API delivers the search and generation capabilities of the Miaosou homepage. It supports general search and media asset search, along with features such as user query clarification, multimodal knowledge search, and multi-agent generation.'."\n" .'– General Search: Performs semantic retrieval on centralized knowledge data and applies multi-agent post-processing to the results, such as summary generation, abstracting, and timeline summarization.'."\n" .'– Media Asset Search: Conducts an exhaustive full-text search to retrieve highly relevant knowledge and supports multi-agent post-processing, such as clustering and news extraction.', 'path' => '/quanmiao/aimiaosou/runSearchGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'ID of the Alibaba Cloud Model Studio workspace. To learn how to obtain this ID, see [How to use workspaces](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier for the session task.'."\n" ."\n" .'> By default, you do not need to provide a TaskId. The system generates one automatically. If you specify the same TaskId in subsequent requests, those tasks are grouped into the same conversation.', 'type' => 'string', 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'required' => false], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Search query.', 'type' => 'string', 'example' => '杭州亚运会吉祥物是什么', 'required' => false], ], [ 'name' => 'OriginalSessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Original session identifier. Usually empty. When non-empty, it indicates that the current conversation is based on the referenced session. The system loads parameters and search results from that session and replaces the generated result. Use this for re-generation, changing data sources, or adding new agents.', 'type' => 'string', 'example' => 'xxx', 'required' => false], ], [ 'name' => 'ChatConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Session configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'GenerateTechnology' => [ 'title' => '', 'description' => 'Generation technology:'."\n" ."\n" .'- copilotReference: Q\\&A-style search'."\n" ."\n" .'- copilotPrecise: Pure search', 'enumValueTitles' => ['copilotPrecise' => 'copilotPrecise', 'copilotReference' => 'copilotReference'], 'type' => 'string', 'example' => 'copilotReference', 'required' => false, ], 'SearchParam' => [ 'description' => 'Search parameters.', 'title' => '', 'type' => 'object', 'properties' => [ 'StartTime' => ['title' => '', 'description' => 'Start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725983999999', 'required' => false], 'EndTime' => ['title' => '', 'description' => 'End time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725983999999', 'required' => false], 'SearchSources' => [ 'description' => 'List of search sources.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search source:'."\n" ."\n" .'You must provide both Code and DatasetName to uniquely identify a search source.'."\n" ."\n" .'For the built-in Internet search, use:'."\n" ."\n" .'- Code = SystemSearch'."\n" ."\n" .'- DatasetName = QuarkCommonNews', 'type' => 'object', 'properties' => [ 'Code' => [ 'title' => '', 'description' => 'Search source type:'."\n" ."\n" .'- SystemSearch: Built-in system search'."\n" ."\n" .'- CustomSemanticSearch: Custom semantic index search'."\n" ."\n" .'- ThirdSearch: Third-party API search', 'enumValueTitles' => ['SystemSearch' => 'SystemSearch', 'ThirdSearch' => 'ThirdSearch', 'CustomSemanticSearch' => 'CustomSemanticSearch'], 'type' => 'string', 'example' => 'SystemSearch', 'required' => false, ], 'DatasetName' => ['title' => '', 'description' => 'Unique identifier for the search source: matches the dataset name shown in the console, such as 4cb0eda3fad841758262dbe8d61191.', 'type' => 'string', 'example' => 'QuarkCommonNews', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'MultimodalSearchTypes' => [ 'description' => 'Search scope list.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search scope:'."\n" ."\n" .'- text: documents'."\n" ."\n" .'- image: images'."\n" ."\n" .'- audio: audio'."\n" ."\n" .'- video: video', 'enumValueTitles' => ['image' => 'image', 'text' => 'text', 'video' => 'video'], 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => '', ], 'required' => false, 'example' => '', ], 'SearchTextMinScore' => ['title' => '', 'description' => 'Text search threshold: Applies only to custom data sources (range: 0 to 1).', 'type' => 'number', 'format' => 'double', 'example' => '0.66', 'required' => false], 'SearchImageMinScore' => ['title' => '', 'description' => 'Image search threshold: Applies only to custom data sources (range: 0 to 1).', 'type' => 'number', 'format' => 'double', 'example' => '0.66', 'required' => false], 'SearchVideoMinScore' => ['title' => '', 'description' => 'Video search threshold: Applies only to custom data sources (range: 0 to 1).', 'type' => 'number', 'format' => 'double', 'example' => '0.66', 'required' => false], 'SearchAudioMinScore' => ['title' => '', 'description' => 'Voice search threshold: Applies only to custom data sources (range: 0 to 1).', 'type' => 'number', 'format' => 'double', 'example' => '0.66', 'required' => false], 'CategoryUuids' => [ 'description' => 'Unique category identifier.', 'type' => 'array', 'items' => ['description' => 'Unique category identifier.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Tags' => [ 'description' => 'Tags.', 'type' => 'array', 'items' => ['description' => 'A tag.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'CreateTimeStart' => ['description' => 'Start creation time, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111111111111', 'title' => ''], 'CreateTimeEnd' => ['description' => 'End creation time, in UNIX timestamp format.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111111111111', 'title' => ''], 'DocIds' => [ 'description' => 'Array of document IDs.', 'type' => 'array', 'items' => ['description' => 'Document ID.', 'type' => 'string', 'required' => false, 'example' => 'x', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'DocUuids' => [ 'description' => 'Unique document identifier.', 'type' => 'array', 'items' => ['description' => 'Unique document identifier.', 'type' => 'string', 'required' => false, 'example' => 'x', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'example' => '', ], 'SearchModels' => [ 'description' => 'List of search types.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search type:'."\n" ."\n" .'- TextGenerate: Summarize and answer (default)'."\n" ."\n" .'- ExcerptGenerate: Answer using original sentences'."\n" ."\n" .'- TimelineGenerate: Summarize by timeline'."\n" ."\n" .'- PreciseSearch: Pure search (follow-up questions)'."\n" ."\n" .'- ClusterGenerate: Cluster'."\n" ."\n" .'- ExtractNewsElementGenerate: Extract news elements', 'enumValueTitles' => ['TextGenerate' => 'TextGenerate', 'ExtractNewsElementGenerate' => 'ExtractNewsElementGenerate', 'ClusterGenerate' => 'ClusterGenerate', 'TimelineGenerate' => 'TimelineGenerate', 'ExcerptGenerate' => 'ExcerptGenerate'], 'type' => 'string', 'required' => false, 'example' => 'TextGenerate', 'title' => '', ], 'required' => false, 'example' => '', ], 'GenerateLevel' => [ 'title' => '', 'description' => 'Detailedness of the response:'."\n" ."\n" .'- concise: Concise (default)'."\n" ."\n" .'- enhance: Enhanced'."\n" ."\n" .'- free: Free-form'."\n" ."\n" .'- deepResearch: Research-level', 'enumValueTitles' => ['concise' => 'concise', 'enhance' => 'enhance'], 'type' => 'string', 'example' => 'concise', 'required' => false, ], 'EnableThinking' => ['title' => '', 'description' => 'Enable deep thinking.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], 'ExcludeGenerateOptions' => [ 'description' => 'List of generation options to skip.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Generation option to skip:'."\n" ."\n" .'- think (query rewriting)'."\n" ."\n" .'- multimodalSearchThink (multimodal search reasoning)'."\n" ."\n" .'- queryRecommend (query recommendation)', 'type' => 'string', 'required' => false, 'example' => 'think', 'title' => ''], 'required' => false, 'example' => '', ], 'ModelCustomPromptTemplate' => ['title' => '', 'description' => 'Plain-text prompt template for Q\\&A-style search and summary generation. Must include variables {query} and {content}. Example:'."\n" ."\n" .'```text'."\n" .'# Role'."\n" .'You are an expert article retrieval and Q&A assistant.'."\n" ."\n" .'# Goal'."\n" .'Answer or explain the user\'s question "{query}" using the retrieved articles.'."\n" ."\n" .'# Constraints'."\n" .'- Filter by knowledge date if the question mentions a specific date.'."\n" .'- Structure responses clearly.'."\n" .'- Keep responses concise.'."\n" .'- Do not use external data or fabricate answers.'."\n" .'- If unable to answer, respond in the appropriate language:'."\n" .' - Chinese: "Unable to answer based on known information."'."\n" .' - English: "Unable to answer based on the known information."'."\n" ."\n" .'# Input'."\n" .'## Retrieved articles'."\n" .'{content}'."\n" .'```', 'type' => 'string', '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}', 'required' => false], 'ModelCustomVlPromptTemplate' => ['title' => '', 'description' => 'Plain-text prompt template for Q\\&A-style search and summary generation. Must include variables {query} and {content}. Example:'."\n" ."\n" .'```text'."\n" .'# Role'."\n" .'You are an expert article retrieval and Q&A assistant.'."\n" ."\n" .'# Goal'."\n" .'Answer or explain the user\'s question "{query}" using the retrieved articles and images.'."\n" ."\n" .'# Constraints'."\n" .'- Filter by knowledge date if the question mentions a specific date.'."\n" .'- Structure responses clearly.'."\n" .'- Keep responses concise.'."\n" .'- Ignore article content if image content fully answers the question.'."\n" .'- Do not use external data or fabricate answers.'."\n" .'- If unable to answer, respond in the appropriate language:'."\n" .' - Chinese: "Unable to answer based on known information."'."\n" .' - English: "Unable to answer based on the known information."'."\n" ."\n" .'# Input'."\n" .'## Retrieved articles'."\n" .'{content}'."\n" .'```', 'type' => 'string', '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], ], 'required' => false, 'example' => 'xxx', ], ], [ 'name' => 'AgentContext', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Context.', 'title' => '', 'type' => 'object', 'properties' => [ 'BizContext' => [ 'description' => 'Business context.', 'title' => '', 'type' => 'object', 'properties' => [ 'MultimodalMediaSelection' => [ 'description' => 'User-provided or selected multimodal data.', 'title' => '', 'type' => 'object', 'properties' => [ 'SelectionType' => ['title' => '', 'description' => 'The type of referenced data source. Valid values: ‒ all: Retrieves the full data from historical sessions. This value is supported only in clustering scenarios. ‒ selected: Retrieves data from textSearchResult during generation.', 'type' => 'string', 'example' => 'all', 'required' => false], 'SessionId' => ['title' => '', 'description' => 'Unique identifier for the session used as reference during generation. Used for clustering in media asset search.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], 'OriginalSessionId' => ['title' => '', 'description' => 'Unique identifier for the original session. Used to retrieve full results from that session. Required only for media asset search.', 'type' => 'string', 'example' => '原始会话唯一标识：搜索结果取这个会话中的全量，目前仅媒资搜索场景需要', 'required' => false], 'SearchModel' => ['title' => '', 'description' => 'Used only for clustering. Pass ClusterGenerate when performing secondary clustering on cluster subtopics.', 'type' => 'string', 'example' => 'TextGenerate', 'required' => false], 'SearchModelDataValue' => ['title' => '', 'description' => 'When SearchModel = ClusterGenerate, enter the topic name for the subtopic. Include quotation marks if the original value has them.', 'type' => 'string', 'example' => '分类1', 'required' => false], 'TextSearchResult' => [ 'description' => 'Text search results.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'List of text search results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Text search result.', 'type' => 'object', 'properties' => [ 'SearchSourceType' => ['title' => '', 'description' => 'Search source type. Same as searchSource.code.', 'type' => 'string', 'example' => 'SystemSearch', 'required' => false], 'SearchSource' => ['title' => '', 'description' => 'Unique identifier for the search source. Same as searchSource.datasetName.', 'type' => 'string', 'example' => 'QuarkCommonNews', 'required' => false], 'SearchSourceName' => ['title' => '', 'description' => 'Name of the search source.', 'type' => 'string', 'example' => '互联网搜索', 'required' => false], 'PubTime' => ['title' => '', 'description' => 'Publication time.', 'type' => 'string', 'example' => '2024-11-25 14:25:59', 'required' => false], 'Source' => ['title' => '', 'description' => 'Source.', 'type' => 'string', 'example' => '新华社', 'required' => false], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => '文章标题', 'required' => false], 'Content' => ['title' => '', 'description' => 'Content.', 'type' => 'string', 'example' => '文章内容', 'required' => false], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx', 'required' => false], 'Summary' => ['title' => '', 'description' => 'Article summary.', 'type' => 'string', 'example' => '文章摘要', 'required' => false], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xxx', 'required' => false], 'Score' => ['title' => '', 'description' => 'Relevance score.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'required' => false], 'Chunks' => [ 'description' => 'Relevant chunks.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Chunk.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'example' => '', ], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => '文档-自定义的唯一ID', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'SkipCurrentSupplement' => ['description' => 'Skip follow-up questions.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], 'AskUser' => ['title' => '', 'description' => 'Follow-up question.', 'type' => 'string', 'required' => false, 'example' => '您想了解关于xx的哪些信息？'], 'AskUserKeywords' => [ 'description' => 'List of recommended keywords for follow-up questions.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Recommended keyword for follow-up questions.', 'type' => 'string', 'required' => false, 'example' => 'xx'], 'required' => false, 'example' => '', ], 'UserBack' => ['title' => '', 'description' => 'User feedback to follow-up questions.', 'type' => 'string', 'required' => false, 'example' => '地点'], 'UserBackKeywords' => [ 'description' => 'List of keywords from user feedback to follow-up questions.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Keyword from user feedback to follow-up questions.', 'type' => 'string', 'required' => false, 'example' => 'xx'], 'required' => false, 'example' => '', ], 'CurrentStep' => ['title' => '', 'description' => 'Current step.', 'type' => 'string', 'required' => false, 'example' => 'think'], 'NextStep' => ['title' => '', 'description' => 'Next step.', 'type' => 'string', 'required' => false, 'example' => 'generate'], 'SupplementDataType' => ['title' => '', 'description' => 'Data type needed for reasoning: searchQuery.', 'type' => 'string', 'required' => false, 'example' => 'searchQuery'], 'SupplementEnable' => ['title' => '', 'description' => 'Specifies whether supplementation is required.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ModelId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Model ID:'."\n" ."\n" .'- quanmiao-max: Quanmiao-Max'."\n" ."\n" .'- quanmiao-plus: Quanmiao-Plus', 'type' => 'string', 'example' => 'quanmiao-max', 'required' => false], ], [ 'name' => 'FileUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Image URL. Used for image search and hybrid text-and-image (prompt) search generation.', 'type' => 'string', 'required' => false, 'example' => 'http://xxxx'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'Payload' => [ 'description' => 'Response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs.', 'title' => '', 'type' => 'object', 'properties' => [ 'AgentContext' => [ 'description' => 'Context data.', 'title' => '', 'type' => 'object', 'properties' => [ 'BizContext' => [ 'description' => 'Business context.', 'title' => '', 'type' => 'object', 'properties' => [ 'CurrentStep' => ['title' => '', 'description' => 'Current step in the task.', 'type' => 'string', 'example' => 'start'], 'NextStep' => ['title' => '', 'description' => 'Next step: think, search, or generate.', 'type' => 'string', 'example' => 'search'], 'GeneratedContent' => [ 'description' => 'Generated content.', 'type' => 'object', 'properties' => [ 'ClusterTopicResult' => [ 'description' => 'Clustering result.', 'title' => '', 'type' => 'object', 'properties' => [ 'ClusterTopics' => [ 'description' => 'List of clusters.', 'type' => 'array', 'items' => [ 'description' => 'Cluster.', 'type' => 'object', 'properties' => [ 'Topic' => ['title' => '', 'description' => 'Topic.', 'type' => 'string', 'example' => 'xx'], 'ImageSearchResult' => [ 'description' => 'Image search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'List of search results.', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tags.', 'type' => 'array', 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSourceType' => ['description' => 'Dataset type.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSource' => ['description' => 'Dataset unique identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Unique multimodal data identifier.', 'type' => 'string', 'example' => 'xx'], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Current' => ['title' => '', 'description' => 'Current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'Records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Total' => ['title' => '', 'description' => 'Total records.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'TextSearchResult' => [ 'description' => 'Document search results', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'Search results list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search results', 'type' => 'object', 'properties' => [ 'SearchSourceType' => ['title' => '', 'description' => 'Search source type, same as searchSource.code.', 'type' => 'string', 'example' => 'SystemSearch'], 'SearchSource' => ['title' => '', 'description' => 'The unique identifier of the search source. This is the same as searchSource.datasetName.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'The name of the search source.', 'type' => 'string', 'example' => '互联网搜索'], 'PubTime' => ['title' => '', 'description' => 'Publication time, in the format yyyy-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2023-04-04 08:39:09'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Unique identifier for internal documents.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => 'xx'], 'MultimodalMedias' => [ 'description' => 'A list of multimodal information.', 'type' => 'array', 'items' => [ 'description' => 'Multimodal media information', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'The unique ID of the multimodal data.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal data file type. Valid values:'."\n" ."\n" .'- video: Video.'."\n" ."\n" .'- image: Image.', 'type' => 'string', 'example' => 'image'], 'FileUrl' => ['title' => '', 'description' => 'The URL of the file.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CategoryUuid' => ['description' => 'Category unique identifier', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tags', 'type' => 'array', 'items' => ['description' => 'Tag', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'Current' => ['title' => '', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Total' => ['title' => '', 'description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'VideoSearchResult' => [ 'description' => 'Video search results', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'Search results', 'type' => 'array', 'items' => [ 'description' => 'Search results', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'The name of the search source.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'The unique identifier of the internal document.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Document: a custom unique ID', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Category', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tags', 'type' => 'array', 'items' => ['description' => 'Tag', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3', 'type' => 'string', 'example' => 'x', 'title' => ''], 'SearchSourceType' => ['description' => 'Dataset type', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSource' => ['description' => 'The unique identifier of the dataset.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Unique identifier for the multimodal data', 'type' => 'string', 'example' => 'xx'], 'ClipInfos' => [ 'description' => 'A list of matching information.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Match information', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'Reference confidence level', 'type' => 'number', 'format' => 'double', 'example' => '0.9'], 'From' => ['title' => '', 'description' => 'Start time', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'To' => ['title' => '', 'description' => 'End time', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'Text' => ['title' => '', 'description' => 'Corresponding text, such as ASR transcription results.', 'type' => 'string', 'example' => 'xx'], 'Type' => ['title' => '', 'description' => 'Text type, such as ASR.', 'type' => 'string', 'example' => 'asr'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'FileUrl' => ['title' => '', 'description' => 'The URL of the file.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Current' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'Number of records per page', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Total' => ['title' => '', 'description' => 'Total records', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'AudioSearchResult' => [ 'description' => 'Audio result', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'Audio search results', 'title' => '', 'type' => 'object', 'properties' => [ 'FileUrl' => ['title' => '', 'description' => 'URL', 'type' => 'string', 'example' => 'http://xx'], 'MediaId' => ['title' => '', 'description' => 'The ID.', 'type' => 'string', 'example' => 'xxx'], 'ClipInfos' => [ 'description' => 'List of matching information', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Match information', 'title' => '', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'The threshold.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'From' => ['title' => '', 'description' => 'Start position', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'To' => ['title' => '', 'description' => 'The end position.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'Text' => ['title' => '', 'description' => 'Text content', 'type' => 'string', 'example' => 'xx'], 'Type' => ['title' => '', 'description' => 'Type', 'type' => 'string', 'example' => 'asr'], ], 'example' => '', ], 'example' => '', ], 'Article' => [ 'description' => 'Corresponding document', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'http://xx'], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'docUuid', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'docId', 'type' => 'string', 'example' => 'xx'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Category identity', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name', 'type' => 'array', 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSourceType' => ['description' => 'The type of the dataset.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSource' => ['description' => 'Unique identifier of the dataset', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], ], 'example' => '', ], 'Current' => ['title' => '', 'description' => 'Current page', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'Size', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Total' => ['title' => '', 'description' => 'Total count', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TextGenerate' => ['description' => 'Text result.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'GenerateFinished' => ['title' => '', 'description' => 'Indicates whether the current agent has finished generating.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], 'ExcerptResult' => [ 'description' => 'Result of answering with original sentences.', 'title' => '', 'type' => 'object', 'properties' => [ 'TextGenerate' => ['title' => '', 'description' => 'Generated text.', 'type' => 'string', 'example' => 'xx'], 'SearchResult' => [ 'description' => 'List of search results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'type' => 'object', 'properties' => [ 'TraceabilityId' => ['title' => '', 'description' => 'Traceability ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'SearchSourceType' => ['title' => '', 'description' => 'Search source type. Same as searchSource.code.', 'type' => 'string', 'example' => 'SystemSearch'], 'SearchSource' => ['title' => '', 'description' => 'Search source unique identifier. Same as searchSource.datasetName.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'PubTime' => ['title' => '', 'description' => 'Publication time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2023-04-04 08:39:09'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Content' => ['title' => '', 'description' => 'Body.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'Excerpt' => ['title' => '', 'description' => 'Content answered with original sentences.', 'type' => 'string', 'example' => 'xx'], 'Select' => ['title' => '', 'description' => 'Indicates whether it is a reference.', 'type' => 'boolean', 'example' => 'true'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'float', 'example' => '0.99'], 'Chunks' => [ 'description' => 'List of chunks.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Chunk.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'TextGenerateMultimodalMediaList' => [ 'description' => 'List of accompanying images.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Accompanying image.', 'type' => 'object', 'properties' => [ 'Start' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'End' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'MultimodalMediaList' => [ 'description' => 'List of multimodal data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Multimodal data.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Unique multimodal data identifier.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal file type. Valid values: video, image.', 'type' => 'string', 'example' => 'image'], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'MultimodalMedias' => [ 'description' => 'List of multimodal information items.', 'type' => 'array', 'items' => [ 'description' => 'Multimodal information item.', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'Unique multimodal data identifier.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal file type. Valid values:'."\n" ."\n" .'- video: video'."\n" ."\n" .'- image: image', 'type' => 'string', 'example' => 'image'], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name.', 'type' => 'array', 'items' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'GenerateFinished' => ['title' => '', 'description' => 'Indicates whether the current agent has finished generating.', 'type' => 'boolean', 'example' => 'true'], 'GenerateLevel' => ['title' => '', 'description' => 'Detailedness of the response:'."\n" ."\n" .'- concise: Concise (default)'."\n" ."\n" .'- enhance: Enhanced', 'type' => 'string', 'example' => 'concise'], 'ReasonTextGenerate' => ['title' => '', 'description' => 'Deep thinking content.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'NewsElementResult' => [ 'description' => 'News extraction result.', 'title' => '', 'type' => 'object', 'properties' => [ 'TextGenerate' => ['title' => '', 'description' => 'Generated text content.', 'type' => 'string', 'example' => 'x'], 'NewsElementArticleList' => [ 'description' => 'List of news extractions.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'News extraction.', 'type' => 'object', 'properties' => [ 'TextGenerate' => ['title' => '', 'description' => 'Generated text content.', 'type' => 'string', 'example' => 'xx'], 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceType' => ['title' => '', 'description' => 'Search source type. Same as searchSource.code.', 'type' => 'string', 'example' => 'SystemSearch'], 'SearchSource' => ['title' => '', 'description' => 'Search source unique identifier. Same as searchSource.datasetName.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'PubTime' => ['title' => '', 'description' => 'Publication time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2023-04-04 08:39:09'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Content' => ['title' => '', 'description' => 'Body.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'Select' => ['title' => '', 'description' => 'Indicates whether it is a reference.', 'type' => 'boolean', 'example' => 'true'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'float', 'example' => '0.99'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name.', 'type' => 'array', 'items' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'NewsElementList' => [ 'description' => 'List of news items.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'News item.', 'type' => 'object', 'properties' => [ 'Time' => ['title' => '', 'description' => 'Time.', 'type' => 'string', 'example' => '时间'], 'Location' => ['title' => '', 'description' => 'Location.', 'type' => 'string', 'example' => 'xx'], 'People' => ['title' => '', 'description' => 'People.', 'type' => 'string', 'example' => 'xx'], 'Event' => [ 'description' => 'Event.', 'title' => '', 'type' => 'object', 'properties' => [ 'CauseList' => [ 'description' => 'List of causes.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Cause.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'ProcessList' => [ 'description' => 'List of processes.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Process.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'ResultList' => [ 'description' => 'List of results.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Result.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], ], 'example' => 'task-started', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'GenerateFinished' => ['title' => '', 'description' => 'Indicates whether the current agent has finished generating.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], 'TextGenerateResult' => [ 'description' => 'Summarized answer.', 'title' => '', 'type' => 'object', 'properties' => [ 'TextGenerate' => ['title' => '', 'description' => 'Text generation result.', 'type' => 'string', 'example' => 'xx'], 'TextGenerateMultimodalMediaList' => [ 'description' => 'List of accompanying images.', 'type' => 'array', 'items' => [ 'description' => 'Accompanying image.', 'type' => 'object', 'properties' => [ 'Start' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'End' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'MultimodalMediaList' => [ 'description' => 'List of multimodal data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Multimodal data.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => 'xx'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Media asset ID.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal file type. Valid values: video, image.', 'type' => 'string', 'example' => 'image'], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'ReferenceList' => [ 'description' => 'List of reference articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Reference article.', 'type' => 'object', 'properties' => [ 'TraceabilityId' => ['title' => '', 'description' => 'Traceability ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'SearchSourceType' => ['title' => '', 'description' => 'Search source type. Same as searchSource.code.', 'type' => 'string', 'example' => 'SystemSearch'], 'SearchSource' => ['title' => '', 'description' => 'Search source unique identifier. Same as searchSource.datasetName.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'PubTime' => ['title' => '', 'description' => 'Publication time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2023-04-04 08:39:09'], 'Source' => ['title' => '', 'description' => 'Source.', 'type' => 'string', 'example' => '新华社'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Content' => ['title' => '', 'description' => 'Body.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'Select' => ['title' => '', 'description' => 'Indicates whether it is a reference.', 'type' => 'boolean', 'example' => 'true'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'float', 'example' => '0.99'], 'Chunks' => [ 'description' => 'List of chunks.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Chunk.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Category unique identifier', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name.', 'type' => 'array', 'items' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'MultimodalSearchResultList' => [ 'description' => 'List of multimodal search results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Multimodal search result.', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'List of search results.', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => 'xx'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Media asset ID.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal file type. Valid values: video, image.', 'type' => 'string', 'example' => 'image'], 'ClipInfos' => [ 'description' => 'List of matching segments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Matching segment.', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'double', 'example' => '0.1'], 'From' => ['title' => '', 'description' => 'Start time.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'To' => ['title' => '', 'description' => 'End time.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'Text' => ['title' => '', 'description' => 'Corresponding text, such as ASR transcription.', 'type' => 'string', 'example' => 'xx'], 'Type' => ['title' => '', 'description' => 'Type. Example: asr.', 'type' => 'string', 'example' => 'asr'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TimelineDateStr' => ['title' => '', 'description' => 'Timeline date.', 'type' => 'string', 'example' => '时间脉络-时间'], 'Current' => ['title' => '', 'description' => 'Current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'Items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Total' => ['title' => '', 'description' => 'Total items.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'SearchType' => ['title' => '', 'description' => 'Search type.', 'type' => 'string', 'example' => 'realtime'], 'SearchQuery' => ['title' => '', 'description' => 'Search query.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'GenerateTraceability' => [ 'description' => 'Traceability information.', 'title' => '', 'type' => 'object', 'properties' => [ 'Duplicate' => ['title' => '', 'description' => 'Overall traceability relevance.', 'type' => 'number', 'format' => 'double', 'example' => '0.9'], 'Coordinates' => [ 'description' => 'List of traceability locations.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Traceability location.', 'type' => 'object', 'properties' => [ 'GenerateCoordinate' => [ 'description' => 'Coordinates of the generated document block.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'Number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Y' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Z' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'NewsCoordinate' => [ 'description' => 'Coordinates of the reference document block.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'Number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Y' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Z' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'MediaType' => ['title' => '', 'description' => 'Media asset type.', 'type' => 'string', 'example' => 'image'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'GenerateFinished' => ['title' => '', 'description' => 'Indicates whether the current agent has finished generating.', 'type' => 'boolean', 'example' => 'true'], 'GenerateLevel' => ['title' => '', 'description' => 'Detailedness of the response:'."\n" ."\n" .'- concise: Concise (default)'."\n" ."\n" .'- enhance: Enhanced', 'type' => 'string', 'example' => 'concise'], 'ReasonTextGenerate' => ['title' => '', 'description' => 'Deep thinking content.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'TimelineResult' => [ 'description' => 'Result of summarizing by time.', 'title' => '', 'type' => 'object', 'properties' => [ 'TextGenerate' => ['title' => '', 'description' => 'Text generation result.', 'type' => 'string', 'example' => 'xx'], 'ReferenceList' => [ 'description' => 'List of reference articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Reference article.', 'type' => 'object', 'properties' => [ 'TraceabilityId' => ['title' => '', 'description' => 'Traceability ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'SearchSourceType' => ['title' => '', 'description' => 'Search source type. Same as searchSource.code.', 'type' => 'string', 'example' => 'SystemSearch'], 'SearchSource' => ['title' => '', 'description' => 'Search source unique identifier. Same as searchSource.datasetName.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'PubTime' => ['title' => '', 'description' => 'Publication time. Format: yyyy-MM-dd HH:mm:ss.', 'type' => 'string', 'example' => '2023-04-04 08:39:09'], 'Source' => ['title' => '', 'description' => 'Source.', 'type' => 'string', 'example' => '新华社'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Content' => ['title' => '', 'description' => 'Body.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'Select' => ['title' => '', 'description' => 'Selection status.', 'type' => 'boolean', 'example' => 'true'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'float', 'example' => '0.99'], 'Chunks' => [ 'description' => 'List of chunks.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Chunk.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name.', 'type' => 'array', 'items' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'MultimodalSearchResultList' => [ 'description' => 'List of multimodal search results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Multimodal search result.', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'List of search results.', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Unique multimodal data identifier.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal file type. Valid values: video, image.', 'type' => 'string', 'example' => 'image'], 'ClipInfos' => [ 'description' => 'List of matching segments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Matching segment.', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'double', 'example' => '0.99'], 'From' => ['title' => '', 'description' => 'Start time.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'To' => ['title' => '', 'description' => 'End time.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'Text' => ['title' => '', 'description' => 'Corresponding text, such as ASR transcription.', 'type' => 'string', 'example' => 'xx'], 'Type' => ['title' => '', 'description' => 'Type. Example: asr.', 'type' => 'string', 'example' => 'asr'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'TimelineDateStr' => ['title' => '', 'description' => 'Date string.', 'type' => 'string', 'example' => '2024-09-11'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'GenerateTraceability' => [ 'description' => 'Traceability information.', 'title' => '', 'type' => 'object', 'properties' => [ 'Duplicate' => ['title' => '', 'description' => 'Relevance score.', 'type' => 'number', 'format' => 'double', 'example' => '0.9'], 'Coordinates' => [ 'description' => 'Traceability location.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Traceability location.', 'type' => 'object', 'properties' => [ 'GenerateCoordinate' => [ 'description' => 'Coordinates of the generated document block.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'Number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Y' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Z' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], 'example' => '', ], 'NewsCoordinate' => [ 'description' => 'Coordinates of the reference article.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'Number, starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Y' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Z' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'MediaType' => ['title' => '', 'description' => 'Media asset type.', 'type' => 'string', 'example' => 'image'], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'TextGenerateMultimodalMediaList' => [ 'description' => 'List of accompanying images.', 'type' => 'array', 'items' => [ 'description' => 'Accompanying image.', 'type' => 'object', 'properties' => [ 'Start' => ['title' => '', 'description' => 'Start position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'End' => ['title' => '', 'description' => 'End position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'MultimodalMediaList' => [ 'description' => 'List of multimodal data.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Multimodal data.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xxxx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Unique multimodal data identifier.', 'type' => 'string', 'example' => 'xx'], 'MediaType' => ['title' => '', 'description' => 'Multimodal file type. Valid values: video, image.', 'type' => 'string', 'example' => 'image'], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'GenerateFinished' => ['title' => '', 'description' => 'Indicates whether the current agent has finished generating.', 'type' => 'boolean', 'example' => 'true'], 'ReasonTextGenerate' => ['title' => '', 'description' => 'Deep thinking content.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'VideoSearchResult' => [ 'description' => 'Video search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'List of search results.', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tags.', 'type' => 'array', 'items' => ['description' => 'Tag.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Unique multimodal data identifier.', 'type' => 'string', 'example' => 'xx'], 'ClipInfos' => [ 'description' => 'List of matching segments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Matching segment.', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'Confidence score. For reference only.', 'type' => 'number', 'format' => 'double', 'example' => '0.8'], 'From' => ['title' => '', 'description' => 'Start time of the segment.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'To' => ['title' => '', 'description' => 'End time.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'Text' => ['title' => '', 'description' => 'Corresponding text, such as ASR transcription.', 'type' => 'string', 'example' => 'xx'], 'Type' => ['title' => '', 'description' => 'Type. Example: asr.', 'type' => 'string', 'example' => 'asr'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], 'TraceabilityId' => ['title' => '', 'description' => 'Unique traceability identifier.', 'type' => 'string', 'example' => '1'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'ImageSearchResult' => [ 'description' => 'Image search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'List of search results.', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'type' => 'object', 'properties' => [ 'Article' => [ 'description' => 'Article.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceName' => ['title' => '', 'description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'Article URL.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Article summary.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'Internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xx'], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name.', 'type' => 'array', 'items' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'MediaId' => ['title' => '', 'description' => 'Media data unique identifier.', 'type' => 'string', 'example' => 'xx'], 'FileUrl' => ['title' => '', 'description' => 'File URL.', 'type' => 'string', 'example' => 'xx'], 'TraceabilityId' => ['title' => '', 'description' => 'Unique traceability identifier.', 'type' => 'string', 'example' => '1'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'TextSearchResult' => [ 'description' => 'Text document search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'Current' => ['title' => '', 'description' => 'Current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'Current page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Total' => ['title' => '', 'description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'SearchResult' => [ 'description' => 'The structure of the search result.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocId' => ['title' => '', 'description' => 'Unique document business identifier.', 'type' => 'string', 'example' => 'xx'], 'DocUuid' => ['title' => '', 'description' => 'System internal unique document identifier.', 'type' => 'string', 'example' => 'xx'], 'SearchSourceType' => ['title' => '', 'description' => 'Data source type.', 'type' => 'string', 'example' => 'SystemSearch'], 'SearchSource' => ['title' => '', 'description' => 'Data source unique identifier.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'Data source description.', 'type' => 'string', 'example' => 'xxx'], 'PubTime' => ['title' => '', 'description' => 'Publication time.', 'type' => 'string', 'example' => '2024-11-25 14:25:59'], 'Content' => ['title' => '', 'description' => 'Body.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'URL.', 'type' => 'string', 'example' => 'xx'], 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xx'], 'TraceabilityId' => ['title' => '', 'description' => 'Unique traceability identifier.', 'type' => 'string', 'example' => '1'], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tag name.', 'type' => 'array', 'items' => ['description' => 'Tag name.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'AudioSearchResult' => [ 'description' => 'Voice search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchResult' => [ 'description' => 'Voice search result.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Voice search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => 'xxx'], 'FileUrl' => ['title' => '', 'description' => 'URL.', 'type' => 'string', 'example' => 'http://xxx'], 'Article' => [ 'description' => 'Associated document.', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'example' => 'xx'], 'Url' => ['title' => '', 'description' => 'URL.', 'type' => 'string', 'example' => 'http://xxx'], 'Summary' => ['title' => '', 'description' => 'Summary.', 'type' => 'string', 'example' => 'xxx'], 'DocUuid' => ['title' => '', 'description' => 'UUID.', 'type' => 'string', 'example' => 'xx'], 'DocId' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => 'xx'], 'SearchSourceName' => ['title' => '', 'description' => 'Search source.', 'type' => 'string', 'example' => 'xx'], 'Extend1' => ['description' => 'Extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'List of tags.', 'type' => 'array', 'items' => ['description' => 'Tag value.', 'type' => 'string', 'example' => 'x', 'title' => ''], 'title' => '', 'example' => '', ], 'CategoryUuid' => ['description' => 'Unique category identifier.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'ClipInfos' => [ 'description' => 'List of matching segments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Matching segment.', 'title' => '', 'type' => 'object', 'properties' => [ 'Score' => ['title' => '', 'description' => 'Threshold.', 'type' => 'number', 'format' => 'double', 'example' => '0.9'], 'From' => ['title' => '', 'description' => 'Start position.', 'type' => 'number', 'format' => 'double', 'example' => '1'], 'To' => ['title' => '', 'description' => 'End position.', 'type' => 'number', 'format' => 'double', 'example' => '2'], 'Text' => ['title' => '', 'description' => 'Text content.', 'type' => 'string', 'example' => 'xx'], 'Type' => ['title' => '', 'description' => 'Text type.', 'type' => 'string', 'example' => 'asr'], ], 'example' => '', ], 'example' => '', ], 'TraceabilityId' => ['title' => '', 'description' => 'Unique traceability identifier.', 'type' => 'string', 'example' => '1'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'SearchKeywords' => [ 'description' => 'Reasoning - list of query understanding keywords.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Reasoning - query understanding keyword.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'SearchQueryList' => [ 'description' => 'List of text search queries.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Text search query.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'RecommendSearchQueryList' => [ 'description' => 'Generation - list of recommendations.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Generation - recommendation.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'example' => '', ], 'SupplementDataType' => ['title' => '', 'description' => 'Reasoning - data type to supplement: searchQuery.', 'type' => 'string', 'example' => 'searchQuery'], 'SupplementEnable' => ['title' => '', 'description' => 'Reasoning - whether supplementation is needed.', 'type' => 'boolean', 'example' => 'true'], 'ModelId' => ['title' => '', 'description' => 'Model ID.', 'type' => 'string', 'example' => 'xx'], 'TokenCalculate' => [ 'description' => 'Runtime performance statistics.', 'type' => 'object', 'properties' => [ 'FirstTokenTime' => ['title' => '', 'description' => 'First token time.', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'SearchTime' => ['title' => '', 'description' => 'Search time cost.', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'OutputAvgTime' => ['title' => '', 'description' => 'Average number of tokens output per second.', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'Time' => ['title' => '', 'description' => 'Total time cost.', 'type' => 'number', 'format' => 'float', 'example' => '1'], 'TotalTokens' => ['title' => '', 'description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], 'title' => '', 'example' => '', ], 'AskUser' => ['title' => '', 'description' => 'Follow-up question.', 'type' => 'string', 'example' => '您想了解关于xx的哪些信息？'], 'AskUserKeywords' => [ 'description' => 'List of recommended keywords for follow-up questions.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Recommended keyword for follow-up questions.', 'type' => 'string', 'example' => '时间'], 'example' => '', ], ], 'example' => '', ], ], 'example' => '', ], 'Messages' => [ 'description' => 'List of messages in research mode.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Message in research mode.', 'title' => '', 'type' => 'object', 'properties' => [ 'Id' => ['title' => '', 'description' => 'Node ID.', 'type' => 'string', 'example' => 'xx'], 'Content' => ['title' => '', 'description' => 'Generated text.', 'type' => 'string', 'example' => 'xx'], 'GenerateFinished' => ['title' => '', 'description' => 'Indicates whether the current node has finished.', 'type' => 'boolean', 'example' => ''], 'Clarifications' => ['title' => '', 'description' => 'Indicates whether clarification is needed.', 'type' => 'boolean', 'example' => ''], 'SearchQueries' => [ 'description' => 'List of search queries.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Search query.', 'type' => 'string', 'example' => 'xx'], 'example' => '', ], 'SearchResult' => [ 'description' => 'Search result.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Search result.', 'title' => '', 'type' => 'object', 'properties' => [ 'MultimodalSearchQuery' => ['title' => '', 'description' => 'Multimodal search query.', 'type' => 'string', 'example' => 'xx'], 'Texts' => [ 'description' => 'List of text searches.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Text search.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'example' => '', ], 'Images' => [ 'description' => 'List of image searches.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Image search.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'example' => '', ], 'Audios' => [ 'description' => 'List of audio results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Audio result.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'example' => '', ], 'Videos' => [ 'description' => 'List of video results.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Video result.', 'title' => '', 'type' => 'object', 'properties' => [ 'MediaId' => ['title' => '', 'description' => 'ID.', 'type' => 'string', 'example' => '1'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'example' => '', ], 'NodeCode' => ['title' => '', 'description' => 'Node code:'."\n" ."\n" .'- generateStartStatement'."\n" ."\n" .'- generateSearchQueries'."\n" ."\n" .'- multiSearch'."\n" ."\n" .'- readSearchResult'."\n" ."\n" .'- reflection'."\n" ."\n" .'- generate', 'type' => 'string', 'example' => 'generateStartStatement'], 'SearchQuery' => ['title' => '', 'description' => 'Current node search query.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'OutputTokens' => ['title' => '', 'description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '2'], 'InputTokens' => ['title' => '', 'description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'TotalTokens' => ['title' => '', 'description' => 'Total token count', 'type' => 'integer', 'format' => 'int64', 'example' => '3'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'Header' => [ 'description' => 'Response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'SessionId' => ['title' => '', 'description' => 'Conversation ID.', 'type' => 'string', 'example' => 'x'], 'TraceId' => ['title' => '', 'description' => 'Full link ID.', 'type' => 'string', 'example' => 'xx'], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => 'x'], 'OriginSessionId' => ['title' => '', 'description' => 'Source session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Event' => ['title' => '', 'description' => 'SSE event.', 'type' => 'string', 'example' => 'task-failed'], 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => 'AccessForbid'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'xx'], 'EventInfo' => ['title' => '', 'description' => 'Event description.', 'type' => 'string', 'example' => 'xx'], 'ResponseTime' => ['title' => '', 'description' => 'Response time, in milliseconds (ms).', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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\\": false,\\n \\"Clarifications\\": false,\\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"}]', 'title' => 'MiaoSou - Intelligent Search', 'description' => '### Integration notes:'."\n" ."\n" .'- This API uses the HTTP Server-Sent Events (SSE) protocol.'."\n" ."\n" .'- The OpenAPI console does not support SSE inference protocols and cannot be used for direct testing. For SDK-based integration examples (Java and Python), see the [Miaosou Best Practices](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) documentation.'."\n" ."\n" .'- To obtain the latest version of the Java asynchronous SDK, click [this link](https://api.aliyun.com/api-tools/sdk/AiMiaoBi?version=2023-08-01\\&language=java-async-tea\\&tab=primer-doc).'."\n" ."\n" .'### Data sources for search:'."\n" ."\n" .'Supports three dataset types. See the [Miaosou Best Practices](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) documentation for details.'."\n" ."\n" .'- Built-in “Internet search” dataset: Supports open-domain text, images, and video (video is not yet available) from the Internet.'."\n" ."\n" .'- Semantic (RAG) dataset: Manages enterprise private knowledge bases and supports text, images, video, and voice (voice is not yet available).'."\n" ."\n" .'- Third-party API dataset: Integrates directly with your own enterprise search APIs.', 'changeSet' => [ ['createdAt' => '2025-11-12T02:50:44.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-09-29T12:05:41.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-06-23T13:54:47.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-06-05T11:27:43.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-05-07T11:57:23.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-04-29T13:10:20.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2025-03-31T11:56:06.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunSearchGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunSearchSimilarArticles' => [ 'summary' => 'Miao Search enables text-to-text search.', 'path' => '/quanmiao/aimiaosou/runSearchSimilarArticles', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get this ID, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'ChatConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Communication configuration parameters.', 'type' => 'object', 'properties' => [ 'SearchParam' => [ 'description' => 'Search configuration parameters.', 'type' => 'object', 'properties' => [ 'SearchSources' => [ 'description' => 'Search sources.', 'type' => 'array', 'items' => [ 'description' => 'Search source ', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Search source type:'."\n" ."\n" .'- SystemSearch: Built-in system search.'."\n" ."\n" .'- CustomSemanticSearch: Custom semantic index search.'."\n" ."\n" .'- ThirdSearch: Third-party API search.', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch', 'title' => ''], 'Name' => ['description' => 'Search source name (optional).', 'type' => 'string', 'required' => false, 'example' => '互联网搜索', 'title' => ''], 'DatasetName' => ['description' => 'Unique identifier of the search source.', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'CategoryUuids' => [ 'description' => 'Category UUID ', 'type' => 'array', 'items' => ['description' => 'Category UUID ', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Tags' => [ 'description' => 'Tag Name', 'type' => 'array', 'items' => ['description' => 'Tag Name', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension Field 1', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension Field 2', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension Field 3', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'CreateTimeStart' => ['description' => 'Start Creation Time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], 'CreateTimeEnd' => ['description' => 'Creation Time cutoff, in UNIX timestamp format. ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], 'StartTime' => ['description' => 'Start Time ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1725983999999', 'title' => ''], 'EndTime' => ['description' => 'End Time ', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '111', 'title' => ''], 'DocUuids' => [ 'description' => 'Document UUID', 'type' => 'array', 'items' => ['description' => 'Document UUID', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'DocIds' => [ 'description' => 'Document ID', 'type' => 'array', 'items' => ['description' => 'Document ID', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'DocTypes' => [ 'description' => 'Document types: text, image, video, audio, pdf, word, ppt, etc.', 'type' => 'array', 'items' => ['description' => 'Document Type', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'Article title.', 'type' => 'string', 'required' => false, 'example' => '标题', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => ['description' => 'Document type.', 'type' => 'string', 'required' => false, 'example' => 'html', 'title' => ''], ], [ 'name' => 'Url', 'in' => 'formData', 'schema' => ['description' => 'Article URL.', 'type' => 'string', 'required' => true, 'example' => 'https://xxx/xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'Server-sent event. Valid values: task-started, task-finished, and task-failed.', 'type' => 'string', 'example' => 'task-started'], 'SessionId' => ['title' => '', 'description' => 'Session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'EventInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Text generation result.', 'type' => 'string', 'example' => '文本生成结果'], 'Articles' => [ 'description' => 'Article list.', 'type' => 'array', 'items' => [ 'description' => 'Article ', 'type' => 'object', 'properties' => [ 'DocUuid' => ['description' => 'Article ID.', 'type' => 'string', 'example' => 'a26c2c1', 'title' => ''], 'SearchSourceName' => ['description' => 'Search source name.', 'type' => 'string', 'example' => '互联网搜索', 'title' => ''], 'PubTime' => ['description' => 'Publication time.', 'type' => 'string', 'example' => '2025-01-16 18:07:22', 'title' => ''], 'Source' => ['description' => 'Source website.', 'type' => 'string', 'example' => 'xxx.com', 'title' => ''], 'Title' => ['description' => 'Title.', 'type' => 'string', 'example' => '标题', 'title' => ''], 'Url' => ['description' => 'URL.', 'type' => 'string', 'example' => 'https://xxx', 'title' => ''], 'Summary' => ['description' => 'Summary.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'DocId' => ['description' => 'Custom unique document ID.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'CategoryUuid' => ['description' => 'UUID of the category', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend1' => ['description' => 'Extension field 1', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'label ', 'type' => 'array', 'items' => ['description' => 'label ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'SearchSource' => ['description' => 'Search source', 'type' => 'string', 'example' => 'QuarkCommonNews', 'title' => ''], 'SearchSourceType' => ['description' => 'Type of dataset', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'DocType' => ['description' => 'Document Type: '."\n" .'- plainText: plain text; content is required '."\n" .'- richText: rich text in HTML format; content is required '."\n" .'- text: text file; url is required '."\n" .'- pdf: url is required '."\n" .'- word: url is required '."\n" .'- image: Image; url is required. Supports most common image formats such as GIF, PNG, JPG, and JPEG '."\n" .'- video: Video; url is required. Supports most common video formats such as MP4, AVI, WMV, and MOV ', 'type' => 'string', 'example' => 'text', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'Usage' => [ 'description' => 'instance: The image is running and used by an ECS instance.'."\n" ."\n" .'none: The image is idle and not used by any ECS instance.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '81', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'MiaoSou - Text Search', 'changeSet' => [ ['createdAt' => '2025-03-18T12:02:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:RunSearchSimilarArticles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunStepByStepWriting' => [ 'summary' => 'Writes content in a step-by-step pattern using an outline and summaries.', 'path' => '/quanmiao/miaobi/runStepByStepWriting', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Obtain a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The prompt.', 'type' => 'string', 'required' => true, 'example' => '提示词'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID. You can reuse the same task ID for a multi-turn conversation.'."\n" ."\n" .'> By default, you do not need to specify this parameter. The system automatically generates a task ID. If you specify the same TaskId for subsequent tasks, the tasks are considered part of the same conversation group.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of a single-turn conversation.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'OriginSessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the original conversation when regenerating content.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'WritingConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The writing configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Domain' => [ 'title' => '', 'description' => 'The writing domain.'."\n" ."\n" .'- media (default): Media writing.'."\n" ."\n" .'- government: Official document writing.', 'type' => 'string', 'example' => 'media', 'enum' => ['media', 'government'], 'required' => false, ], 'Keywords' => [ 'description' => 'The keywords. This affects article retrieval.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A keyword (string).', 'type' => 'string', 'required' => false, 'example' => '关键词', 'title' => ''], 'required' => false, 'example' => '', ], 'PromptTag' => [ 'description' => 'The prompt assistant.', 'title' => '', 'type' => 'object', 'properties' => [ 'NecessaryTips' => ['title' => '', 'description' => 'Necessary tips.', 'type' => 'string', 'example' => '必要提示', 'required' => false], 'Position' => ['title' => '', 'description' => 'The position or stance.', 'type' => 'string', 'example' => '立场', 'required' => false], 'ReverseWords' => ['title' => '', 'description' => 'Reverse the words.', 'type' => 'string', 'example' => '反向词', 'required' => false], 'Theme' => ['title' => '', 'description' => 'The theme.', 'type' => 'string', 'example' => '主题', 'required' => false], ], 'required' => false, 'example' => '', ], 'Scene' => ['title' => '', 'description' => 'The step-by-step writing scenario.'."\n" ."\n" .'- Scenarios supported for media writing: News Writing (default), News Commentary, and General Style.'."\n" ."\n" .'- Scenarios supported for official document writing: Notification (default), Announcement, Bulletin, Request for Instruction, Decision, Letter, and General Style.', 'type' => 'string', 'example' => '新闻写作', 'required' => false], 'Step' => [ 'title' => '', 'description' => 'The writing step.'."\n" ."\n" .'- Generate outline: OutlineGenerate'."\n" ."\n" .'- Generate summary: MiniDocSummary'."\n" ."\n" .'- Writing (default): Generate article', 'type' => 'string', 'example' => 'Writing', 'enum' => ['OutlineGenerate', 'MiniDocSummary', 'Writing'], 'required' => false, ], 'Tags' => [ 'description' => 'Control parameters for writing, such as style, length, and output language.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A tag object.', 'type' => 'object', 'properties' => [ 'Keyword' => ['title' => '', 'description' => 'The value of the option.', 'type' => 'string', 'example' => '10', 'required' => false], 'Tag' => ['title' => '', 'description' => 'The tag of the option. For example, gcNumberSizeTag=10.', 'type' => 'string', 'example' => 'gcNumberSizeTag', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'UseSearch' => ['title' => '', 'description' => 'Specifies whether to automatically supplement materials.', 'type' => 'boolean', 'example' => 'true', 'required' => false], 'SummaryReturnType' => ['title' => '', 'description' => 'The return type of the summary result.
'."\n" ."\n" .'- Structure:'."\n" .' Returns a JSON string in payload.output.text. Example format: `{"event":"{outline}","message":"{message}"}`'."\n" ."\n" .'- Content: Returns only the plain text summary content in payload.output.text. Example format:'."\n" .' `Outline: {outline}'."\n" ."\n" .'{message}'."\n" ."\n\n" .' Outline: {outline}'."\n" ."\n" .'{message}`'."\n" ."\n" .'- Event: Returns only the outline content itself in payload.output.text each time an outline is completed. Typically, six describes are returned.', 'type' => 'string', 'required' => false, 'example' => 'Structure'], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The reference article data for writing.', 'title' => '', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The reference article data for writing.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The reference article data for writing.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者', 'required' => false], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容', 'required' => false], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID', 'required' => false], 'DocUuid' => ['title' => '', 'description' => 'The internal unique ID of the document.', 'type' => 'string', 'example' => '8a20e007a6174522af4d6a2657d5526f', 'required' => false], 'MediaUrl' => ['description' => 'The URL of the original material.', 'type' => 'string', 'example' => 'http://www.example.com', 'required' => false, 'title' => ''], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-09-10 14:17:54', 'required' => false], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网', 'required' => false], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要', 'required' => false], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '文章标签', 'required' => false], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题', 'required' => false], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'MiniDoc' => [ 'description' => 'The ranked article segments for subsequent model generation.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'An article segment.', 'type' => 'string', 'required' => false, 'example' => '文章片段', 'title' => ''], 'required' => false, 'example' => '', ], 'Outlines' => [ 'description' => 'The outline. You can specify a data source to generate the outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An outline.', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The specified data source for the outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An article object.', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The article content.', 'type' => 'string', 'example' => '文章内容', 'required' => false], 'Title' => ['title' => '', 'description' => 'The article title.', 'type' => 'string', 'example' => '文章标题', 'required' => false], 'Url' => ['title' => '', 'description' => 'The article URL.', 'type' => 'string', 'example' => '文章链接', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'example' => '大纲', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'Summarization' => [ 'description' => 'The summary result from the Large Language Model (LLM).', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The summary result (model context).', 'type' => 'string', 'required' => false, 'example' => '摘编结果（模型上下文）', 'title' => ''], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'The Server-Sent Events (SSE) event. \\`task-started\\`: The task begins. \\`task-finished\\`: The task is complete. \\`task-failed\\`: The task failed.', 'type' => 'string', 'example' => 'task-started'], 'OriginSessionId' => ['title' => '', 'description' => 'The parent session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'The session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'The full-link trace ID.', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output.', 'title' => '', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The reference articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A reference article.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容'], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID'], 'DocUuid' => ['title' => '', 'description' => 'The internal unique ID of the document.', 'type' => 'string', 'example' => 'f1da53894e784759946d22e2cb2b522a'], 'MediaUrl' => ['description' => 'The URL of the original material.', 'type' => 'string', 'example' => 'http://www.example.com', 'title' => ''], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-09-10 14:17:53'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网'], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要'], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '文章标签'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ExtraOutput' => [ 'description' => 'Extra output fields.', 'title' => '', 'type' => 'object', 'properties' => [ 'summarization' => [ 'description' => 'The list of summaries. This field is returned when summaries are generated step-by-step.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A summary field.', 'type' => 'string', 'example' => '摘编'], 'example' => '', ], ], 'example' => '', ], 'MiniDoc' => [ 'description' => 'A list of segments after the article layout has been optimized.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'An article segment after fine-grained sorting.', 'type' => 'string', 'example' => '文章精排之后的片段'], 'example' => '文章精排之后的片段', ], 'SearchQuery' => ['title' => '', 'description' => 'The rewritten query.', 'type' => 'string', 'example' => '大模型改变世界'], 'Text' => ['title' => '', 'description' => 'The text generation result.', 'type' => 'string', 'example' => '文本生成结果'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Information about token usage.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '65'], 'OutputTokens' => ['title' => '', 'description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '80'], 'TotalTokens' => ['title' => '', 'description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '32'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Step-by-step writing ', 'description' => 'The Quanmiao product supports iframe embedding. For more information, see [Customer Onboarding: Quanmiao Public Cloud iframe Customization](~~3000990~~).', 'changeSet' => [ ['createdAt' => '2024-12-30T11:38:26.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunStepByStepWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunStyleFeatureAnalysis' => [ 'summary' => 'Analyzes the stylistic features of content.', 'path' => '/quanmiao/aimiaobi/runStyleFeatureAnalysis', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. Get the [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'], ], [ 'name' => 'Contents', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A collection of custom content texts.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Custom content text.', 'type' => 'string', 'example' => '生活是一种律动，须有光有影，有左有右，有晴有雨，趣味就在这变而不猛的曲折里，微微暗些，再明起来，则暗得有趣，而明乃更明。——老舍', 'required' => false], 'required' => false, 'example' => '', ], ], [ 'name' => 'MaterialIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A collection of Material Library IDs.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Material Library ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'End' => ['title' => '', 'description' => 'Whether the output is complete. True indicates completion.', 'type' => 'boolean', 'example' => ''], 'Header' => [ 'description' => 'The streaming output header, containing general return information.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '403'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.'], 'Event' => ['title' => '', 'description' => 'Event type.', 'type' => 'string', 'example' => 'result-generated'], 'EventInfo' => ['title' => '', 'description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件'], 'SessionId' => ['title' => '', 'description' => 'Session ID.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], 'TraceId' => ['title' => '', 'description' => 'Trace ID.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'], ], 'example' => '', ], 'Payload' => [ 'description' => 'The payload of the response, in JSON structure', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output content object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Output content.', 'type' => 'string', 'example' => '这是测试输出'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Large Language Model (LLM) token usage information.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'Input Tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'OutputTokens' => ['title' => '', 'description' => 'Output Tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'TotalTokens' => ['title' => '', 'description' => 'Total Tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"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' => 'Content Characteristics Analysis', 'description' => 'Quanmiao products support iframe embedding. For more information, see [Customer Integration: Quanmiao Public Cloud iframe Customization Solution](~~3000990~~).', 'changeSet' => [ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunStyleFeatureAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunSummaryGenerate' => [ 'summary' => 'Generates a summary of content.', 'path' => '/quanmiao/aimiaobi/runSummaryGenerate', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'paid', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-2setzb9x4ewsd'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content to summarize.', 'type' => 'string', 'required' => true, 'example' => '创新政务社交媒体功能。鼓励各地区、各部门结合实际，开发政务社交媒体的特色功能，如在线咨询服务、政策解读、互动问答等，增强政务社交媒体的互动性和实用性，提升公众参与度。'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom prompt for summary generation.', 'type' => 'string', 'example' => '请为上述内容生成一段摘要，字数在100~200字以内。', 'default' => '请为上述内容生成一段摘要，字数在100~200字以内。', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'End' => ['title' => '', 'description' => 'Indicates whether the response is complete. Set to true when complete.', 'type' => 'boolean', 'example' => ''], 'Header' => [ 'description' => 'Streaming output header. Contains general response information.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '403'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'Pop sign mismatch, please check.'], 'Event' => ['title' => '', 'description' => 'Event type.', 'type' => 'string', 'example' => 'result-generated'], 'EventInfo' => ['title' => '', 'description' => 'Event description.', 'type' => 'string', 'example' => '模型生成事件'], 'SessionId' => ['title' => '', 'description' => 'Session ID.', 'type' => 'string', 'example' => '3cd10828-0e42-471c-8f1a-931cde20b035'], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], 'TraceId' => ['title' => '', 'description' => 'Trace ID.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Response payload in JSON format.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Output text.', 'type' => 'string', 'example' => '这是测试输出'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Large Language Model (LLM) token usage information.', 'title' => '', 'type' => 'object', 'properties' => [ 'InputTokens' => ['title' => '', 'description' => 'Number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'OutputTokens' => ['title' => '', 'description' => 'Number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'TotalTokens' => ['title' => '', 'description' => 'Total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200'], ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique request ID.', 'type' => 'string', 'example' => 'd3be9981-ca2d-4e17-bf31-1c0a628e9f99'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"End\\": false,\\n \\"Header\\": {\\n \\"ErrorCode\\": \\"403\\",\\n \\"ErrorMessage\\": \\"Pop sign mismatch, please check.\\",\\n \\"Event\\": \\"result-generated\\",\\n \\"EventInfo\\": \\"模型生成事件\\",\\n \\"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' => 'Summary Generation', 'changeSet' => [ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunSummaryGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunTextPolishing' => [ 'summary' => 'Polishes the specified text.', 'path' => '/quanmiao/aimiaobi/runTextPolishing', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. Obtain the [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Text content.', 'type' => 'string', 'required' => true, 'example' => '文本内容'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom polishing requirements.', 'type' => 'string', 'required' => false, 'example' => '自定义的润色要求'], ], [ 'name' => 'OriginContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Original article.', 'type' => 'string', 'required' => false, 'example' => '原始文章内容'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task ID. The same task ID shares a session. The task timeout is 12 hours.', 'type' => 'string', 'example' => 'taskld-xxxxx', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code.', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'The SSE event. \\`task-started\\`: started. \\`task-finished\\`: finished. \\`task-failed\\`: failed.', 'type' => 'string', 'example' => 'task-started'], 'OriginSessionId' => ['title' => '', 'description' => 'Parent session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'Session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'End-to-end trace ID.', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Text generation result.', 'type' => 'string', 'example' => '文本生成结果'], ], 'example' => '', ], 'Usage' => [ 'description' => 'Token consumption.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of tokens used for input.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'Number of tokens used for output.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens used for this call.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['description' => 'Unique request identifier.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Polish', 'changeSet' => [ ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTextPolishing', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunTitleGeneration' => [ 'summary' => 'Miaobi generates titles.', 'path' => '/quanmiao/aimiaobi/runTitleGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier for the Alibaba Cloud Model Studio workspace. For more information, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Data for title generation.', 'type' => 'object', 'properties' => [ 'Contents' => [ 'description' => 'List of main content.', 'type' => 'array', 'items' => ['description' => 'Main content.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier for the associated creative article.'."\n" ."\n" .'> The system automatically generates the TaskId by default. You do not need to specify it. If subsequent tasks use the same TaskId, they belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'TitleCount', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Number of titles to generate, maximum 10.', 'type' => 'string', 'required' => false, 'example' => '10'], ], [ 'name' => 'DeduplicatedTitles', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A collection of titles to deduplicate against the newly generated titles. The total character count for all titles must not exceed 5K.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The title to deduplicate.', 'type' => 'string', 'required' => false, 'example' => '标题xxxx', 'title' => ''], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'AccessForbid', 'title' => ''], 'ErrorMessage' => ['description' => 'Error code message.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Event' => ['description' => 'SSE event.', 'type' => 'string', 'example' => 'task-failed', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'StatusCode' => ['description' => 'Status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => '50a1cc8e-717e-4a2b-a76b-dc9734a8564b', 'title' => ''], 'TraceId' => ['description' => 'Full link ID.', 'type' => 'string', 'example' => '0a3d448f17000139741898287e0eb3', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Outputs.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'Article title.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of tokens used for input.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'Number of tokens used for output.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens used for this call.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Unique request identifier.', 'type' => 'string', 'example' => '94512A33-8EC1-5452-A793-5C91F18ED2F0', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'AccessForbid', 'title' => ''], 'Message' => ['description' => 'Error description.', 'type' => 'string', 'example' => '数据不存在', 'title' => ''], 'Success' => ['description' => 'Whether the operation was successful: true for success, false for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Title Generation', 'changeSet' => [ ['createdAt' => '2025-03-31T12:47:21.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTitleGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunTopicSelectionMerge' => [ 'summary' => 'Selects and aggregates topics for MiaoCe.', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Custom merge prompt', 'type' => 'string', 'required' => false, 'example' => '请从xxxx的角度，分析xxxx事件'], ], [ 'name' => 'Topics', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of topic perspectives to merge', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Topic perspective to merge', '$ref' => '#/components/schemas/TopicSelection', 'required' => false, 'title' => '', 'example' => ''], 'required' => true, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'SSE event. Values: task-started, task-finished, or task-failed', 'type' => 'string', 'example' => 'task-started'], 'OriginSessionId' => ['title' => '', 'description' => 'Parent session ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'Session ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'StatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'End-to-end trace ID', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Text generation result', 'type' => 'string', 'example' => '文本生成结果'], 'Topic' => ['description' => 'Merged topic selection object', '$ref' => '#/components/schemas/TopicSelection', 'title' => '', 'example' => ''], ], 'example' => '', ], 'Usage' => [ 'description' => 'Token usage', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens', 'type' => 'integer', 'format' => 'int64', 'example' => '78', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens used', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], 'TokenMap' => [ 'description' => 'Detailed token consumption', 'additionalProperties' => ['description' => 'Token count consumed', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], 'type' => 'object', 'title' => '', 'example' => '', ], 'TotalTokens' => ['description' => 'Total number of tokens used in this call', 'type' => 'integer', 'format' => 'int64', 'example' => '38', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'End' => ['description' => 'Indicates whether the response packet is complete', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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\\\\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"}]', 'title' => 'Topic Hot Spot Fusion ', 'description' => 'All Miao products support iframe embedding. For more information, see [Customer Integration: Miao Public Cloud iFrame Customization Plan](~~3000990~~).', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTopicSelectionMerge', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunTranslateGeneration' => [ 'summary' => 'Translates text for content creation using AMB.', 'path' => '/quanmiao/aimiaobi/runTranslateGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The data required for generation.', 'type' => 'object', 'properties' => [ 'Contents' => [ 'description' => 'A list of content.', 'type' => 'array', 'items' => ['description' => 'The content.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Optional. The unique ID of the associated creative article.'."\n" ."\n" .'> You do not need to specify TaskId. The system generates one automatically. If subsequent tasks use the same TaskId, they belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'The target language for translation. The source language is automatically detected.'."\n" ."\n" .'| Language | Prompt value |'."\n" .'| ------------------ | ------------ |'."\n" .'| English | English |'."\n" .'| Simplified Chinese | Chinese |'."\n" .'| Japanese | Japanese |'."\n" .'| Korean | Korean |'."\n" .'| Spanish | Spanish |'."\n" .'| French | French |'."\n" .'| Portuguese | Portuguese |'."\n" .'| German | German |'."\n" .'| Italian | Italian |', 'type' => 'string', 'required' => true, 'example' => 'English', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response header', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'AccessForbid', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Event' => ['description' => 'The Server-Sent Events (SSE) event.', 'type' => 'string', 'example' => 'task-failed', 'title' => ''], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '91C2B2B8-7D12-4A8D-A724-1E576D30C096', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '0abb781d17146157564845243e20b5', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output data', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text generation result.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage information', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of tokens used for the input.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'The number of tokens used for the output.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalTokens' => ['description' => 'The total number of tokens used in the call.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'DA021073-17CE-5CCF-9FEB-93226C766887', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Chinese-English Translation', 'changeSet' => [ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTranslateGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunVideoScriptGenerate' => [ 'summary' => 'Generates video clip scripts using AI.', 'path' => '/miaobi/runVideoScriptGenerate', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The prompt for the video script.', 'type' => 'string', 'required' => true, 'example' => '写一篇关于黄山旅游的脚本'], ], [ 'name' => 'UseSearch', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to use an internet search. If you set this to true, the system performs intention recognition and then searches the internet for relevant reference materials.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'ScriptLength', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The length of the script. Valid values:'."\n" ."\n" .'20\\~75: 10 to 15 seconds of normal speaking time.'."\n" ."\n" .'75\\~150: 15 to 30 seconds of normal speaking time.'."\n" ."\n" .'150\\~300: Approximately 30 to 60 seconds of normal speaking time.'."\n" ."\n" .'\\>=300: 60 seconds or more of normal speaking time.', 'type' => 'string', 'example' => '>=300', 'required' => false], ], [ 'name' => 'Language', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The language of the generated script.'."\n" .'Recommended values:'."\n" ."\n" .'zh-CN: Chinese'."\n" ."\n" .'en-US: English'."\n" ."\n" .'The default is Chinese.', 'type' => 'string', 'example' => 'en-US', 'required' => false], ], [ 'name' => 'ScriptNumber', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of scripts to generate. The default is 1. You can generate a maximum of three scripts at a time.'."\n" .'If you specify multiple scripts, the results are returned in parallel streams. The client distinguishes between the streams using different session IDs.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'ScriptNumberExceed', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message returned when the call fails.', 'type' => 'string', 'example' => '脚本篇数超限', 'title' => ''], 'Event' => ['description' => 'The event name.', 'type' => 'string', 'example' => 'result-generated'."\n", 'title' => ''], 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'StatusCode' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'TaskId' => ['description' => 'The task ID.', 'type' => 'string', 'example' => 'b057f2fa-2277-477b-babf-cbc062307828', 'title' => ''], 'TraceId' => ['description' => 'The trace ID.', 'type' => 'string', 'example' => '2150451a17191950923411783e2927', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output content object.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The text generation result.', 'type' => 'string', 'example' => '大家好，我是[xxx]。今天带大家走进黄山，感受奇松、怪石、云海、温泉的绝美风光。首站迎客松，800年历史，枝干如臂，热情迎接每一位游客。接着登光明顶，360度全景尽收眼底。再探秘西海大峡谷，体验原始自然的震撼。最后，在温泉中放松身心，享受旅途的美好。希望这次旅行能给你留下难忘的记忆。我是[你的名字]，感谢观看，我们下次再见！","91522b25a4f440189320c9ede8ae6c85":"大家好，我是[您的名字]，今天带大家探索黄山的奇妙之旅。首先，我们将见到黄山的象征——迎客松，感受它800年的历史与欢迎。随后攀登光明顶，迎接壮丽的日出；漫步西海大峡谷，体验险峻之美；最后，在温泉中放松身心。希望这次旅行能让你爱上黄山。谢谢观看！","1c23af4a899e4b908bdcffa7d8d0ddc9":"大家好，欢迎来到黄山！这里以奇松、怪石、云海、温泉四绝闻名。从云谷寺开始，感受古朴氛围；挑战百步云梯，体验攀登乐趣；漫步西海大峡谷，领略壮丽景色；最后在玉屏楼迎接日出，享受心灵的宁静。希望这次旅行给你留下美好回忆！', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'The token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of tokens used for the input.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'OutputTokens' => ['description' => 'The number of tokens for the output.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'The unique ID of the request. This field is returned when the \\`Content-Type\\` is \\`json\\`.', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code. This field is returned when the \\`Content-Type\\` is \\`json\\`.', 'type' => 'string', 'example' => '403', 'title' => ''], 'Code' => ['description' => 'The status code. A value of 200 indicates a normal response. This field is returned when the \\`Content-Type\\` is \\`json\\`.', 'type' => 'string', 'example' => 'NoPermission', 'title' => ''], 'Message' => ['description' => 'The error description. This field is returned when the \\`Content-Type\\` is \\`json\\`.', 'type' => 'string', 'example' => 'You are not authorized to perform this action.', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure. This field is returned when the \\`Content-Type\\` is \\`json\\`.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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-generated video editing script', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunVideoScriptGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunWriteToneGeneration' => [ 'summary' => 'Calls AMB to rewrite text in a new tone.', 'path' => '/quanmiao/aimiaobi/runWriteToneGeneration', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Data required for generation.', 'type' => 'object', 'properties' => [ 'Contents' => [ 'description' => 'List of main text blocks.', 'type' => 'array', 'items' => ['description' => 'Main text block.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], 'required' => true, 'title' => '', 'example' => '', ], ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the associated article.'."\n" ."\n" .'> You do not need to specify TaskId. The system generates it automatically. If you use the same TaskId in later requests, those requests belong to the same conversation group.', 'type' => 'string', 'required' => false, 'example' => '7AA2AE16-D873-5C5F-9708-15396C382EB1', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'Tone. Examples include lyrical, bold, subtle, excited, friendly, and inspirational.', 'type' => 'string', 'required' => true, 'example' => '励志', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'Response headers.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'AccessForbid', 'title' => ''], 'ErrorMessage' => ['description' => 'Error message returned when the call fails.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'Event' => ['description' => 'Server-sent event (SSE).', 'type' => 'string', 'example' => 'task-failed', 'title' => ''], 'SessionId' => ['description' => 'Session ID.', 'type' => 'string', 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51', 'title' => ''], 'TaskId' => ['description' => 'Task ID.', 'type' => 'string', 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51', 'title' => ''], 'TraceId' => ['description' => 'End-to-end trace ID.', 'type' => 'string', 'example' => 'F1953EE6-157C-40DC-BBF1-87C98AC27C51', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Payload' => [ 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'Output data.', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'Generated text.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'Usage' => [ 'description' => 'Token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'Number of input tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'Number of output tokens used.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TotalTokens' => ['description' => 'Total number of tokens used in this call.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'RequestId' => ['description' => 'Unique request ID.', 'type' => 'string', 'example' => 'FB698445-61DA-5361-BF73-1C5F1157E888', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Writing Style Rewriting', 'changeSet' => [ ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunWriteToneGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunWriting' => [ 'summary' => 'Direct writing.', 'path' => '/quanmiao/aimiaobi/runWriting', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The prompt.', 'type' => 'string', 'required' => true, 'example' => '提示词'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the task. You can reuse the same task ID in a multi-turn conversation.'."\n" ."\n" .'> You do not need to specify TaskId. The system generates one automatically. If you use the same TaskId for multiple tasks, they are grouped into a single conversation.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of a single-turn conversation.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'OriginSessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the original conversation to use for regeneration.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'WritingConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The writing configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Domain' => ['title' => '', 'description' => 'The writing domain.'."\n" ."\n" .'- media: Media'."\n" ."\n" .'- government: Government'."\n" ."\n" .'- market: Marketing', 'type' => 'string', 'example' => 'media', 'required' => false], 'PromptTag' => [ 'description' => 'The prompt assistant.', 'title' => '', 'type' => 'object', 'properties' => [ 'NecessaryTips' => ['title' => '', 'description' => 'Necessary tips.', 'type' => 'string', 'example' => '必要提示', 'required' => false], 'Position' => ['title' => '', 'description' => 'The stance.', 'type' => 'string', 'example' => '立场', 'required' => false], 'ReverseWords' => ['title' => '', 'description' => 'Negative keywords.', 'type' => 'string', 'example' => '反向词', 'required' => false], 'Theme' => ['title' => '', 'description' => 'The theme.', 'type' => 'string', 'example' => '主题', 'required' => false], ], 'required' => false, 'example' => '', ], 'Tags' => [ 'description' => 'Control parameters for writing, such as the style, length, and output language.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Control parameters for writing, such as the style, length, and output language.', 'type' => 'object', 'properties' => [ 'Keyword' => ['title' => '', 'description' => 'The value of the option.', 'type' => 'string', 'example' => '10', 'required' => false], 'Tag' => ['title' => '', 'description' => 'The tag of the option. Example: gcNumberSizeTag=10.', 'type' => 'string', 'example' => 'gcNumberSizeTag', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'UseSearch' => ['title' => '', 'description' => 'Specifies whether to automatically add reference materials.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ReferenceData', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The reference article data for writing.', 'title' => '', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The reference article data for writing.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The reference article data for writing.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者', 'required' => false], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容', 'required' => false], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID', 'required' => false], 'DocUuid' => ['title' => '', 'description' => 'The internal unique ID of the document.', 'type' => 'string', 'example' => '2124ca4d48a542d788aa86151e1a8c8b', 'required' => false], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-08-28 11:38:28', 'required' => false], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网', 'required' => false], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要', 'required' => false], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '文章标签', 'required' => false], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题', 'required' => false], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'The Server-Sent Events (SSE) event. Valid values: task-started (the task starts), task-finished (the task is complete), and task-failed (the task failed).', 'type' => 'string', 'example' => 'task-started'], 'OriginSessionId' => ['title' => '', 'description' => 'The parent session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'The session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'StatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'The trace ID.', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'The response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output.', 'title' => '', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The reference articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A reference article.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容'], 'DocId' => ['title' => '', 'description' => 'The custom unique ID of the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID'], 'DocUuid' => ['title' => '', 'description' => 'The internal unique ID of the document.', 'type' => 'string', 'example' => '98229f6001cf4deeb1668191d4eccc75'], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-08-28 11:38:28'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网'], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要'], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '文章标签'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'MiniDoc' => [ 'description' => 'A list of refined segments from the article.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A refined segment from the article.'."\n" .'\\*', 'type' => 'string', 'example' => '文章精排之后的片段'], 'example' => '文章精排之后的片段', ], 'SearchQuery' => ['title' => '', 'description' => 'The rewritten query.', 'type' => 'string', 'example' => '大模型改变世界'], 'Text' => ['title' => '', 'description' => 'The generated text.', 'type' => 'string', 'example' => '文本生成结果'], ], 'example' => '', ], 'Usage' => [ 'description' => 'The token usage.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of tokens used for the input.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'OutputTokens' => ['description' => 'The number of tokens used for the output.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], 'TokenMap' => [ 'description' => 'The detailed token usage.', 'additionalProperties' => ['description' => 'The detailed token usage.', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], 'type' => 'object', 'title' => '', 'example' => '', ], 'TotalTokens' => ['description' => 'The total number of tokens used in the current call.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'End' => ['description' => 'Indicates whether the current request is complete.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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 },\\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' => 'Direct Writing ', 'description' => 'This API is deprecated. For more information, see [RunWritingV2](~~2922606~~).'."\n" ."\n" .'The Quanmiao product supports iframe embedding. For more information, see [Customer integration: Quanmiao Public Cloud iframe customization](~~3000990~~).', 'changeSet' => [ ['createdAt' => '2024-12-16T05:44:25.000Z', 'description' => 'Response parameters changed'], ['createdAt' => '2024-12-05T12:45:04.000Z', 'description' => 'Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'RunWritingV2' => [ 'summary' => 'AI writing', 'path' => '/quanmiao/aimiaobi/runWritingV2', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the Model Studio workspace. For more information, see [Obtain a Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique ID of the task. You can reuse the same task ID for a multi-turn conversation.'."\n" ."\n" .'> The system automatically generates a `TaskId` if you do not specify one. Reusing the same `TaskId` for subsequent requests groups them into a single conversation.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'SessionId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of a single-turn conversation. This parameter is deprecated and its use is discouraged.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'WritingScene', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The writing scene. Valid values: `government` (government affairs), `media`, `market` (marketing), `office`, and `custom`.', 'type' => 'string', 'required' => false, 'example' => 'media'], ], [ 'name' => 'WritingStyle', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The writing style. For a list of supported styles, see [ListWritingStyles](~~2922609~~).', 'type' => 'string', 'required' => false, 'example' => '新闻评论'], ], [ 'name' => 'DistributeWriting', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable step-by-step writing. For more information, see the `Step` parameter description.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'PromptMode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The prompt mode. Valid values: `Template` (template mode) and `PE` (advanced PE mode).'."\n" ."\n" .'1. If this parameter is omitted, you must provide the `Prompt` parameter. We recommend that the prompt includes the topic, length, requirements, and prohibitions.'."\n" ."\n" .'2. If `PromptMode` is set to `Template`, you must provide `WritingParams`, which is a dictionary of string key-value pairs. For the required schema, see the `.Data.TemplateDefine[].Fields` field in the response of the [ListWritingStyles](~~2922609~~) operation.'."\n" ."\n" .'3. If `PromptMode` is set to `PE`, you must pass `WritingParams` with the following two fields:'."\n" ."\n" .' 1. `topic`: Required. The topic to write about.'."\n" ."\n" .' 2. `prompt`: Optional. Any additional custom prompts or writing requirements.', 'type' => 'string', 'required' => false, 'example' => 'Template'], ], [ 'name' => 'Step', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The step for step-by-step writing. Valid values:'."\n" ."\n" .'- `OutlineGenerate`: Outline generation'."\n" ."\n" .'- `Writing`: Article writing'."\n" ."\n" .'When `DistributeWriting` is `true`, the default flow for step-by-step writing is to first generate an outline and then write the content based on it.', 'type' => 'string', 'required' => false, 'example' => 'Writing'], ], [ 'name' => 'Articles', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of articles to use as references. **Note:** When you provide this parameter, web search is disabled, overriding the `UseSearch` and `SearchSources` parameters.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The article object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'The title of the article.', 'type' => 'string', 'required' => false, 'example' => '文章标题'], 'Content' => ['title' => '', 'description' => 'The content of the article.', 'type' => 'string', 'required' => false, 'example' => '文章内容'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/aaa.docx'], 'Source' => ['title' => '', 'description' => 'The source of the article.', 'type' => 'string', 'required' => false, 'example' => '新华社'], 'SearchSourceName' => ['title' => '', 'description' => 'The name of the search source.', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'required' => false, 'example' => '2024-11-25 14:25:59'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'GcNumberSizeTag', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'A string that specifies the desired article length. Examples: "about 300 words", "about 600 words", "about 1,000 words", or "about 2,000 words".', 'type' => 'string', 'required' => false, 'example' => '2000字左右'], ], [ 'name' => 'GcNumberSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of articles to write. If you request multiple articles, the system returns them concurrently, each with a unique session ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2'], ], [ 'name' => 'Language', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The output language for the article.'."\n" ."\n" .'- `en`: English'."\n" ."\n" .'- `zh`: Chinese'."\n" ."\n" .'- Other languages or specific style requirements can also be specified.', 'type' => 'string', 'required' => false, 'example' => 'en'], ], [ 'name' => 'Keywords', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of keywords used for both search and writing.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A keyword used for both search and writing.', 'type' => 'string', 'required' => false, 'example' => '关键词'], 'required' => false, 'example' => '', ], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The writing prompt. You must provide either `Prompt` or `WritingParams`. For more information, see the description of the `PromptMode` parameter.', 'type' => 'string', 'required' => false, 'example' => '提示词'], ], [ 'name' => 'WritingParams', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The parameters for template-based writing, provided as a dictionary of string key-value pairs. You must provide either `Prompt` or `WritingParams`. For more information, see the description of the `PromptMode` parameter.', 'additionalProperties' => ['description' => 'A template writing parameter.', 'type' => 'string', 'example' => '模板写作参数', 'title' => ''], 'title' => '', 'type' => 'object', 'required' => false, 'example' => '', ], ], [ 'name' => 'Outlines', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of outlines for step-by-step writing. This parameter is deprecated. Use `OutlineList` instead.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The outline object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Outline' => ['title' => '', 'description' => 'The outline.', 'type' => 'string', 'required' => false, 'example' => '大纲'], 'Articles' => [ 'description' => 'A list of articles referenced by the outline.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'An article referenced by the outline.', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['title' => '', 'description' => 'The title of the article.', 'type' => 'string', 'required' => false, 'example' => '标题'], 'Content' => ['title' => '', 'description' => 'The content of the article.', 'type' => 'string', 'required' => false, 'example' => '正文内容'], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'required' => false, 'example' => '文章URL'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'Summarization', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of summarization objects, used for step-by-step writing.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The summarization object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Event' => ['title' => '', 'description' => 'The name of the event.', 'type' => 'string', 'required' => false, 'example' => '事件名称'."\n" ."\n"], 'Message' => ['title' => '', 'description' => 'The summary of the event.', 'type' => 'string', 'required' => false, 'example' => '事件摘编'."\n" ."\n"], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'MiniDocs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of article snippets.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The article snippet object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content of the snippet.', 'type' => 'string', 'required' => false, 'example' => '片段内容'."\n" ."\n"], 'Star' => ['title' => '', 'description' => 'Specifies whether to prioritize this snippet.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], 'Index' => ['title' => '', 'description' => 'The index of the article snippet in the referenced article.', 'type' => 'string', 'required' => false, 'example' => '索引'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'UseSearch', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable web search. If `true`, the system uses its built-in web search feature. Default: `false`.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ 'name' => 'SearchSources', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of specified search sources to use.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The search source object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The type of search source. Valid values: `SystemSearch` (built-in system search), `CustomSemanticSearch` (search of a custom semantic index), and `ThirdSearch` (search through a third-party API).', 'type' => 'string', 'required' => false, 'example' => 'SystemSearch'], 'Name' => ['title' => '', 'description' => 'The description of the search source. This parameter is deprecated and has no effect.', 'type' => 'string', 'required' => false, 'example' => '互联网搜索'], 'DatasetName' => ['title' => '', 'description' => 'The unique identifier of the data source.', 'type' => 'string', 'required' => false, 'example' => 'QuarkCommonNews'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'OutlineList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of outlines for step-by-step writing.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The outline.', '$ref' => '#/components/schemas/WritingOutline', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'SourceTraceMethod', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The source tracing method. Currently, only `modelSourceTrace` is supported. If set to `modelSourceTrace`, the model adds citation markers (for example, `[[1]]`) to the end of each cited snippet in the generated text. The citation index starts at 1.', 'type' => 'string', 'required' => false, 'example' => 'modelSourceTrace'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'BaseLlmResponse', 'title' => '', 'type' => 'object', 'properties' => [ 'Header' => [ 'description' => 'The response header.', 'title' => '', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => '错误码'], 'ErrorMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误信息'], 'Event' => ['title' => '', 'description' => 'The type of event. The service returns two types of events: writing events and other events.'."\n" ."\n" .'The writing event, `task-progress-start-generating`, indicates that the output contains the complete article information.'."\n" ."\n" .'Other events, such as `writing-instruction-analysis` (instruction analysis), `task-progress-news-search-end` (web search), and `result-intent-recognition-end` (intent recognition), can be monitored through the `payload.output.text` field or ignored.', 'type' => 'string', 'example' => 'task-progress-start-generating'], 'OriginSessionId' => ['title' => '', 'description' => 'The parent session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'SessionId' => ['title' => '', 'description' => 'The session ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'StatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TraceId' => ['title' => '', 'description' => 'The trace ID.', 'type' => 'string', 'example' => '全链路ID'], ], 'example' => '', ], 'Payload' => [ 'description' => 'The response payload.', 'title' => '', 'type' => 'object', 'properties' => [ 'Output' => [ 'description' => 'The output.', 'title' => '', 'type' => 'object', 'properties' => [ 'Articles' => [ 'description' => 'The reference articles.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A reference article.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容'], 'DocId' => ['title' => '', 'description' => 'The custom unique ID for the document.', 'type' => 'string', 'example' => '文档-自定义的唯一ID'], 'DocUuid' => ['title' => '', 'description' => 'The internal unique identifier for the document.', 'type' => 'string', 'example' => '98229f6001cf4deeb1668191d4eccc75'], 'PubTime' => ['title' => '', 'description' => 'The publication time.', 'type' => 'string', 'example' => '2024-08-28 11:38:28'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网'], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要'], 'Tag' => ['title' => '', 'description' => 'The tag.', 'type' => 'string', 'example' => '文章标签'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题'], 'Url' => ['title' => '', 'description' => 'The article URL.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'MiniDoc' => [ 'description' => 'A list of refined article snippets.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'A refined article snippet.', 'type' => 'string', 'example' => '文章精排之后的片段'], 'example' => '文章精排之后的片段', ], 'SearchQuery' => ['title' => '', 'description' => 'The result of the query rewrite.', 'type' => 'string', 'example' => '大模型改变世界'], 'Text' => ['title' => '', 'description' => 'The generated text.', 'type' => 'string', 'example' => '文本生成结果'], 'Outlines' => [ 'description' => 'A list of outlines. This field is returned when `writingStyle` is set to `outlineWriting` and `step` is `outlineWriting`.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'An outline.', 'title' => '', '$ref' => '#/components/schemas/WritingOutline', 'example' => ''], 'example' => '', ], 'Title' => ['title' => '', 'description' => 'The article title. This field is returned when `writingStyle` is set to `outlineWriting` and `step` is `outlineWriting`.', 'type' => 'string', 'example' => '文章标题'], 'SearchResult' => ['title' => '', 'description' => 'The search result. This field is returned when `writingStyle` is set to `outlineWriting` and `step` is `OutlineSearch`.', '$ref' => '#/components/schemas/OutlineSearchResult', 'example' => ''], 'GenerateTraceability' => ['title' => '', 'description' => 'A traceability object, returned when the `modelSourceTrace` parameter is provided.', '$ref' => '#/components/schemas/GenerateTraceability', 'example' => ''], ], 'example' => '', ], 'Usage' => [ 'description' => 'The token usage statistics.', 'type' => 'object', 'properties' => [ 'InputTokens' => ['description' => 'The number of input tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '78', 'title' => ''], 'OutputTokens' => ['description' => 'The number of output tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], 'TokenMap' => [ 'description' => 'A detailed breakdown of token consumption.', 'additionalProperties' => ['description' => 'The number of tokens used for a specific sub-task.', 'type' => 'integer', 'format' => 'int64', 'example' => '44', 'title' => ''], 'type' => 'object', 'title' => '', 'example' => '', ], 'TotalTokens' => ['description' => 'The total number of tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '38', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'End' => ['description' => 'Indicates whether this is the final message in the response stream.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Intelligent Writing', 'description' => 'For instructions on embedding Quanmiao products using an iframe, see [Customer integration\\_Quanmiao public cloud iframe customized solution](~~3000990~~).', 'requestParamsDescription' => '## API request examples'."\n" ."\n" .'### 1. Direct writing (using a prompt)'."\n" ."\n" .'```json'."\n" .'{'."\n" .' // Workspace ID'."\n" .' "WorkspaceId": "your-workspace-id",'."\n" .' // Enable search'."\n" .' "UseSearch":true,'."\n" .' // Writing prompt'."\n" .' "Prompt": "Write a news commentary on the development of artificial intelligence. The word count must be 800-1000 words. The response must have a clear viewpoint, a logical structure, and avoid exaggerated expressions."'."\n" .'}'."\n" .'```'."\n" ."\n" .'### 2. Template-based writing (PromptMode=Template)'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "WorkspaceId": "your-workspace-id",'."\n" .' "WritingScene": "media",'."\n" .' "WritingStyle": "news-commentary",'."\n" .' "PromptMode": "Template",'."\n" .' "WritingParams": {'."\n" .' "topic": "Breakthroughs in AI applications in healthcare: a hospital successfully uses an AI-assisted diagnostic system with an accuracy rate above 95%.",'."\n" .' "corePerspective": "The rapid growth of AI in healthcare shows how technological innovation reshapes traditional industries. However, it also requires robust laws, regulations, and ethical standards to ensure the safe and fair use of the technology."'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'**Template field descriptions (media scene):**'."\n" ."\n" .'- **topic** (required): The topic for the article. Describe the news event in plain language or find a fresh angle on common news stories. 1,000–2,000 characters.'."\n" ."\n" .'- **corePerspective** (required): The core perspective. Clearly state a value judgment and reflect the topic\'s social significance or industry impact. 1,000–2,000 characters.'."\n" ."\n" .'### 3. PE mode (PromptMode=PE)'."\n" ."\n" .'> (Uses a custom prompt. The system generates content based solely on the prompt, which separates the topic from other requirements.)'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "WorkspaceId": "your-workspace-id",'."\n" .' "PromptMode": "PE",'."\n" .' "WritingParams": {'."\n" .' "topic": "AI development trends",'."\n" .' "prompt": "Word count: 800-1000 words. Writing style: Clear viewpoint, logical structure, and vivid language. Content requirements: Must include a background, current situation analysis, and future outlook, with an emphasis on innovation. Prohibitions: Avoid exaggerated language and overly technical terms. Other requirements: Must cite specific data and have a well-defined structure."'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'**Template field descriptions (PE mode):**'."\n" ."\n" .'- **topic** (required): The main topic of the content.'."\n" ."\n" .'- **prompt** (optional): Additional custom instructions and writing requirements. Organize the content using the following format:'."\n" ."\n" .' - **Word count**: e.g., "800-1000 words" or "around 1500 words"'."\n" ."\n" .' - **Writing style**: e.g., "clear viewpoint and logical structure" or "vivid and engaging language"'."\n" ."\n" .' - **Content requirements**: e.g., "must include a background, current situation analysis, and future outlook" or "emphasize innovation"'."\n" ."\n" .' - **Prohibitions**: e.g., "do not use exaggerated language" or "avoid technical jargon"'."\n" ."\n" .' - **Other requirements**: e.g., "must cite specific data" or "requires a well-defined structure"'."\n" ."\n" .' You can separate multiple requirements with periods, semicolons, or line breaks. Recommended format: `"Word count: XXX. Writing style: XXX. Content requirements: XXX. Prohibitions: XXX. Other requirements: XXX."`'."\n" ."\n" .'### 4. Step-by-step writing - Step 1: Generate an outline'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "WorkspaceId": "your-workspace-id",'."\n" .' "WritingStyle": "outlineWriting",'."\n" .' "WritingScene": "others",'."\n" .' "Step": "OutlineGenerate",'."\n" .' "Prompt": "Generate an outline for a news commentary on the development of artificial intelligence. The final article should be 800-1000 words and include three sections: background, current situation analysis, and future outlook."'."\n" .'}'."\n" .'```'."\n" ."\n" .'**Description:**'."\n" ."\n" .'- The first step generates an outline. The response contains the `Outlines` field, which includes the generated outline structure.'."\n" ."\n" .'- The `Prompt` should clearly specify the outline\'s topic, word count, and structural requirements.'."\n" ."\n" .'- Save the returned `Outlines` structure to pass to the second step.'."\n" ."\n" .'### 5. Step-by-step writing - Step 2: Write using the outline'."\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": "Background of AI development",'."\n" .' "WordCount": "200-300 words",'."\n" .' "Children": ['."\n" .' {'."\n" .' "OutlineId": "outline-001-001",'."\n" .' "Outline": "Origins of AI technology",'."\n" .' "WordCount": "100-150 words",'."\n" .' "Children": []'."\n" .' },'."\n" .' {'."\n" .' "OutlineId": "outline-001-002",'."\n" .' "Outline": "Current state of development",'."\n" .' "WordCount": "100-150 words",'."\n" .' "Children": []'."\n" .' }'."\n" .' ]'."\n" .' },'."\n" .' {'."\n" .' "OutlineId": "outline-002",'."\n" .' "Outline": "Analysis of AI applications",'."\n" .' "WordCount": "300-400 words",'."\n" .' "Children": []'."\n" .' },'."\n" .' {'."\n" .' "OutlineId": "outline-003",'."\n" .' "Outline": "Future development trends",'."\n" .' "WordCount": "300-400 words",'."\n" .' "Children": []'."\n" .' }'."\n" .' ],'."\n" .' "Prompt": "Write the article based on the generated outline. The word count should be 800-1,000 words, and the article must have a clear viewpoint, a logical structure, and vivid language."'."\n" .'}'."\n" .'```'."\n" ."\n" .'**Description:**'."\n" ."\n" .'- In the second step, write the content by passing the `Outlines` structure from the first step.'."\n" ."\n" .'- The `OutlineList` parameter is required and contains the outline tree. Each outline node includes:'."\n" ."\n" .' - **OutlineId** (required): The outline node ID.'."\n" ."\n" .' - **Outline** (required): The outline name.'."\n" ."\n" .' - **WordCount** (optional): The word count requirement for this section.'."\n" ."\n" .' - **Children** (optional): A list of child outlines, which have the same structure as the parent outline.'."\n" ."\n" .'- You can use the `Prompt` parameter to specify additional writing requirements, such as word count, writing style, and content requirements.'."\n" ."\n" .'### 6. Imitative writing'."\n" ."\n" .'```json'."\n" .'{'."\n" .' "WorkspaceId": "your-workspace-id",'."\n" .' "WritingScene": "custom",'."\n" .' "WritingStyle": "imitateWriting",'."\n" .' "PromptMode": "Template",'."\n" .' "WritingParams": {'."\n" .' "topic": "The new energy vehicle market is experiencing rapid growth, with sales exceeding 8 million units in 2024, up 35% year-over-year. Policy support, technological advancements, and increasing consumer acceptance are the key driving factors.",'."\n" .' "styleStructReferenceContent": "[{\\"title\\":\\"The AI industry is seeing explosive growth\\",\\"content\\":\\"【Introduction】\\\\nArtificial intelligence technology is profoundly changing how we work and live. From smart voice assistants and autonomous vehicles to medical diagnostics and financial risk control, the applications for AI continue to expand.\\\\n\\\\n【Current Status】\\\\nAccording to statistics, the global AI market reached $150 billion in 2023 and is projected to exceed $300 billion by 2025. As the world\'s second-largest AI market, China has made significant progress in algorithms, computing power, and data.\\\\n\\\\n【Key Drivers】\\\\nFirst, increased policy support. The government has introduced multiple policies to support the AI industry, establishing special funds and building innovation platforms.\\\\nSecond, continuous technological breakthroughs. Technologies like large models and deep learning are maturing, steadily lowering the barrier to adoption.\\\\nThird, sustained market demand. The acceleration of corporate digital transformation is driving a growing demand for AI solutions.\\\\n\\\\n【Challenges and Outlook】\\\\nDespite rapid development, the AI industry still faces challenges such as data security, algorithmic fairness, and talent shortages. The future requires continuous effort in technological innovation, standards development, and talent cultivation to promote the healthy and sustainable growth of the AI industry.\\"}]"'."\n" .' }'."\n" .'}'."\n" .'```'."\n" ."\n" .'**Template field descriptions (quick imitative writing):**'."\n" ."\n" .'- **topic** (required): The article\'s topic. Describe the main theme and core information for the article. Max 3,000 characters.'."\n" ."\n" .'- **styleStructReferenceContent** (required): A list of reference articles that the system uses to learn structure and style. This list must be a JSON-serialized string. Each element in the array must contain `title` and `content` fields.'."\n" ."\n" .'**Additional notes:**'."\n" ."\n" .'- Reference articles should have a clear, well-defined structure (e.g., Introduction, Current Status, Analysis, Conclusion).'."\n" ."\n" .'- The system learns the structure and writing style from the reference articles and then generates a new article based on the provided topic.'."\n" ."\n" .'- For best results, provide a single reference article with a distinct structure to ensure the generated output is structurally consistent.', 'changeSet' => [ ['createdAt' => '2025-10-11T01:59:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunWritingV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SaveCustomText' => [ 'summary' => 'Saves custom text.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '标题', 'required' => false], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '内容', 'required' => false], ], [ 'name' => 'CommodityCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The commodity code.', 'type' => 'string', 'example' => '商品code', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'integer', 'format' => 'int64', 'example' => '5'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Save custom text', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SaveCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'SaveDataSourceOrderConfig' => [ 'summary' => 'Saves the data source configuration for content creation and general search.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'ProductCode', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'The product type. Valid values:'."\n" ."\n" .'- miaobi'."\n" ."\n" .'- miaosou', 'type' => 'string', 'required' => true, 'enum' => ['miaobi', 'miaosou'], 'example' => 'miaobi', ], ], [ 'name' => 'UserConfigDataSourceList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The data source configuration.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Code description', 'type' => 'string', 'required' => true, 'example' => 'QuarkCommonNews'], 'Name' => ['title' => '', 'description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => '夸克通用搜索'], 'Number' => ['title' => '', 'description' => 'Quantity', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '20'], 'Type' => ['title' => '', 'description' => 'The type of the data source.', 'type' => 'string', 'required' => true, 'example' => 'SystemSearch'], 'Enable' => ['title' => '', 'description' => 'Specifies whether to enable the data source.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], [ 'name' => 'GenerateTechnology', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The generation technology for Miaosou. This parameter is valid only when \\`ProductCode\\` is set to \\`miaosou\\`.'."\n" ."\n" .'Valid values:'."\n" ."\n" .'- copilotPrecise'."\n" ."\n" .'- copilotReference', 'type' => 'string', 'example' => 'copilotReference', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => ['title' => '', 'description' => 'The returned data.', 'type' => 'boolean', 'example' => 'true'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success, and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Save datasource weight configuration', 'changeSet' => [ ['createdAt' => '2025-05-08T10:53:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveDataSourceOrderConfig'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SaveDataSourceOrderConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'SaveMaterialDocument' => [ 'summary' => 'Save material: Save material to the Material Library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Unique identifier for the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'c160c841c8e54295bf2f441432785944_p_efm'], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Document type (html: web page, plainText: plain text, image: 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'], ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Document title', 'type' => 'string', 'required' => false, 'example' => '新闻标题'], ], [ 'name' => 'Author', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'required' => false, 'example' => '作者名称'], ], [ 'name' => 'PubTime', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Publication time, format: 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' => 'Document tags used for classification, etc.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'Keyword', 'type' => 'string', 'required' => false, 'example' => '关键词', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'Url', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'URL of the material', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx/xxx'], ], [ 'name' => 'ExternalUrl', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'URL uploaded by external customers, used only for record keeping', 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx/xxx'."\n"], ], [ 'name' => 'SrcFrom', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Document source (UserUpload: User Upload, IntellijSearch: Intelligent Search, HotViewPoint: Hot Viewpoint)', 'type' => 'string', 'example' => 'IntellijSearch', 'enum' => ['UserUpload', 'IntellijSearch', 'HotViewPoint'], 'required' => false, ], ], [ 'name' => 'TextContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Parsed text content, empty for images', 'type' => 'string', 'required' => false, 'example' => '文本内容'], ], [ 'name' => 'HtmlContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Formatted content', 'type' => 'string', 'required' => false, 'example' => '网页内容'], ], [ 'name' => 'ShareAttr', 'in' => 'formData', 'schema' => [ 'title' => '', 'description' => 'Sharing attribute: 0: private, 1: shared within the workspace', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['0', '1'], 'required' => false, ], ], [ 'name' => 'BothSavePrivateAndShare', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Is the material saved to both the private library and the shared library?', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'Summary', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'required' => false, 'example' => '摘要'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'integer', 'format' => 'int64', 'example' => '12'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error description', 'type' => 'string', 'example' => '数据不存在'], 'RequestId' => ['title' => '', 'description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'false'], ], 'example' => '', ], ], ], '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' => 'Save Material', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SaveMaterialDocument'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SaveMaterialDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'SaveOrUpdateOssConfig' => [ 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'BucketName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the OSS bucket.', 'type' => 'string', 'required' => false, 'example' => 'xxx'], ], [ 'name' => 'EndPoint', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The endpoint of OSS.', 'type' => 'string', 'required' => false, 'example' => 'oss-cn-shanghai.aliyuncs.com'], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique ID of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The business data.', 'type' => 'object', 'properties' => [ 'BucketName' => ['title' => '', 'description' => 'The name of the OSS bucket.', 'type' => 'string', 'example' => 'xxx'], 'Endpoint' => ['title' => '', 'description' => 'The endpoint of OSS.', 'type' => 'string', 'example' => 'oss-cn-shanghai.aliyuncs.com'], 'Enable' => ['title' => '', 'description' => 'Indicates whether the OSS configuration is active. \\`1\\`: The configuration is active. \\`0\\`: The configuration is inactive.', 'type' => 'string', 'example' => '1'], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Configuration - Cloud Storage - Parameter Settings', 'summary' => 'Configuration: Cloud storage parameter settings', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SaveOrUpdateOssConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], '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"}]', 'translator' => 'machine', ], 'SaveStyleLearningResult' => [ 'summary' => 'Saves a custom writing style.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'RewriteResult', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Revised content', 'type' => 'string', 'required' => false, 'example' => '用户修订后内容'], ], [ 'name' => 'StyleName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the saved writing style', 'type' => 'string', 'required' => false, 'example' => '学习报告'], ], [ 'name' => 'AigcResult', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content generated by AIGC', 'type' => 'string', 'required' => false, 'example' => 'AIGC 生成的内容'], ], [ 'name' => 'CustomTextIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Collection of custom text samples', 'title' => '', 'type' => 'array', 'items' => ['description' => '1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '18', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'AgentKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identity of the workspace: AgentKey', 'type' => 'string', 'example' => 'xxxxx_p_efm', 'required' => false], ], [ 'name' => 'TaskId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'ID of the task. Must match the taskID used in the SSE interface', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'required' => false], ], [ 'name' => 'MaterialIdList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Collection of material IDs', 'type' => 'array', 'items' => ['description' => '1', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Unique ID of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'boolean', 'example' => 'true'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'Success' => ['title' => '', 'description' => 'Indicates success: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Save the writing style learning analysis result', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SaveStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SearchDatasetDocuments' => [ 'summary' => 'Searches documents in a data source.', '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' => '', 'description' => 'The ID of the Model Studio workspace. For more information, see [Get workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xx'], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The search query.', 'type' => 'string', 'required' => true, 'example' => '搜索内容'], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the dataset. You must specify either `DatasetId` or `DatasetName`.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the dataset.', 'type' => 'string', 'example' => '数据集名称', 'required' => false], ], [ 'name' => 'IncludeContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to include the document content in the search results. The default value is `false`.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'Extend1', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'A business parameter.', 'type' => 'string', 'example' => '业务参数', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of documents to return per page.', 'type' => 'string', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'CategoryUuids', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of category UUIDs for filtering.', 'type' => 'array', 'items' => ['description' => 'Category unique identifier', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Tags', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of tags for filtering.', 'type' => 'array', 'items' => ['description' => 'Tag', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'Extend2', 'in' => 'formData', 'schema' => ['description' => 'A reserved business parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'Extend3', 'in' => 'formData', 'schema' => ['description' => 'A reserved business parameter.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'CreateTimeStart', 'in' => 'formData', 'schema' => ['description' => 'The start time for document creation, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'CreateTimeEnd', 'in' => 'formData', 'schema' => ['description' => 'The end time for document creation, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'StartTime', 'in' => 'formData', 'schema' => ['description' => 'The start of the time range for filtering, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'EndTime', 'in' => 'formData', 'schema' => ['description' => 'The end of the time range for filtering, specified as a Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'DocUuids', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of document UUIDs for filtering.', 'type' => 'array', 'items' => ['description' => 'Document unique identifier', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'DocIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of document IDs for filtering.', 'type' => 'array', 'items' => ['description' => 'Document ID', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'SearchMode', 'in' => 'formData', 'schema' => ['description' => 'The search mode.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'DocTypes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of document types for filtering.', 'type' => 'array', 'items' => ['description' => 'Document type: such as text, image, video, audio, PDF, Word, PPT, etc.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The data.', 'title' => '', 'type' => 'object', 'properties' => [ 'Documents' => [ 'description' => 'The document list.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A document in the document list.', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'The unique system ID of the document.', 'type' => 'string', 'example' => 'xxx'], 'Url' => ['description' => 'The URL of the document.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Content' => ['description' => 'The content of the document.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Summary' => ['title' => '', 'description' => 'The summary of the document.', 'type' => 'string', 'example' => '文章摘要'], 'Title' => ['description' => 'The title of the document.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'PubTime' => ['description' => 'The publication time, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'example' => '2024-12-09 17:09:40', 'title' => ''], 'SourceFrom' => ['title' => '', 'description' => 'The source of the document.', 'type' => 'string', 'example' => '来源'], 'DocId' => ['title' => '', 'description' => 'The user-defined unique ID for the document.', 'type' => 'string', 'example' => 'xx'], 'DocType' => ['description' => 'The document type.', 'type' => 'string', 'example' => 'text', 'title' => ''], 'CategoryUuid' => ['description' => 'The unique identifier for the category.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend1' => ['description' => 'Custom extension field 1.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Custom extension field 2.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Custom extension field 3.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'A list of tags.', 'type' => 'array', 'items' => ['description' => 'The name of a tag.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'SearchSourceType' => ['description' => 'The dataset type.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSource' => ['description' => 'The unique identifier for the dataset.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'SearchSourceName' => ['description' => 'The name of the dataset.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Score' => ['description' => 'The relevance score.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], 'ChunkInfos' => [ 'description' => 'A list of relevant chunks from the document. This field is returned only in `document` mode.', 'type' => 'array', 'items' => [ 'description' => 'An object that contains details about a relevant chunk.', 'type' => 'object', 'properties' => [ 'Chunk' => ['description' => 'The content of the chunk.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Score' => ['description' => 'The relevance score of the chunk.', 'type' => 'number', 'format' => 'double', 'example' => '0.77', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Chunk' => ['description' => 'The content of the relevant chunk. This field is returned only in `chunk` mode.', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates if the request succeeded (`true`) or failed (`false`).', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The status message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'data source - search document ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:SearchDatasetDocuments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SearchNews' => [ 'summary' => 'Searches for news based on your input. This feature is currently limited to web search.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique ID of the workspace. For more information, see [AgentKey](~~3027170~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'SearchSources', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'enumValueTitles' => [], 'description' => 'A list of search sources.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The code of the search source. This parameter is optional. Currently, only \\`QuarkCommonNews\\` is supported.', 'type' => 'string', 'example' => 'QuarkCommonNews', 'required' => false, 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'Query', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The search query.', 'type' => 'string', 'example' => '检索Query', 'required' => false], ], [ 'name' => 'PageSize', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The number of records to return on each page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], [ 'name' => 'Page', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'IncludeContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to include the full text of the article.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], [ 'name' => 'FilterNotNull', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to filter out results with empty content.', 'type' => 'boolean', 'example' => 'false', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PageResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Current' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'Data' => [ 'description' => 'The data returned.', 'type' => 'array', 'items' => [ 'description' => 'The result returned.', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author of the article. This parameter may not be returned for some articles.', 'type' => 'string', 'example' => '作者'], 'Content' => ['title' => '', 'description' => 'The content of the article. This parameter is always returned.', 'type' => 'string', 'example' => '文章内容'], 'DocUuid' => ['title' => '', 'description' => 'The unique ID of the internal document. This parameter is always returned.', 'type' => 'string', 'example' => '9a598b44c6444da5907b8ea68a5f82c4'], 'ImageUrls' => [ 'description' => 'The URLs of the images. This parameter is deprecated and is no longer returned. Do not use it.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The URL of a news image.', 'type' => 'string', 'example' => 'https://www.example.com/aaaa.jpg', 'title' => ''], 'example' => '', ], 'PubTime' => ['title' => '', 'description' => 'The time when the article was published. This parameter is always returned.', 'type' => 'string', 'example' => '2024-01-18 06:46:22'], 'SearchSource' => ['title' => '', 'description' => 'The ID of the internal search source. This parameter is always returned.', 'type' => 'string', 'example' => 'QuarkCommonNews'], 'SearchSourceName' => ['title' => '', 'description' => 'The name of the internal search source. This parameter is always returned.', 'type' => 'string', 'example' => '夸克检索'], 'Source' => ['title' => '', 'description' => 'The source of the article. This parameter may not be returned for some articles.', 'type' => 'string', 'example' => '央视网'], 'Summary' => ['title' => '', 'description' => 'The summary of the article. This parameter may not be returned for some articles.', 'type' => 'string', 'example' => '文章摘要'], 'Tag' => ['title' => '', 'description' => 'The tag of the article. This parameter may not be returned for some articles.', 'type' => 'string', 'example' => '文章标签'], 'Title' => ['title' => '', 'description' => 'The title of the article. This parameter is always returned.', 'type' => 'string', 'example' => '文章标题'], 'UpdateTime' => ['title' => '', 'description' => 'The time when the system was updated. This parameter is deprecated and is no longer returned. Do not use it.', 'type' => 'string', 'example' => '2024-01-18 06:46:22'], 'Url' => ['title' => '', 'description' => 'The URL of the article. This parameter is always returned.', 'type' => 'string', 'example' => '文章URL'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Size' => ['description' => 'The number of records on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success and a value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Total' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Information retrieval', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ['createdAt' => '2024-05-29T08:39:45.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SearchNews'], ], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:SearchNews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'SubmitAsyncTask' => [ 'summary' => 'Executes predefined asynchronous tasks.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique ID of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => '2daaa2e0c209xb26acb97009ea77bd4b_p_efm'], ], [ 'name' => 'TaskName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the task.', 'type' => 'string', 'example' => '任务名称', 'required' => false], ], [ 'name' => 'TaskCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'For details on the task definition, see the task definition table.', 'type' => 'string', 'required' => true, 'example' => 'MaterialDocumentUpload'], ], [ 'name' => 'TaskParam', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task parameters.', 'type' => 'string', 'example' => '{"fileUrl":"https://www.example.com/aaa.doc","fileName":"文件名称","shareAttr":1}', 'required' => false], ], [ 'name' => 'TaskExecuteTime', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The time to run the task. By default, the task runs immediately. Format: YYYY-MM-DD HH:mm:ss', 'type' => 'string', 'example' => '2023-10-14 14:30:00', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'successful'], 'Data' => [ 'description' => 'The returned data.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The unique task ID.', 'type' => 'string', 'example' => 'xxxx'], 'TaskIntermediateResult' => ['title' => '', 'description' => 'The intermediate result.', 'type' => 'any', 'example' => '{}'], 'TaskName' => ['title' => '', 'description' => 'The task name.', 'type' => 'string', 'example' => '任务名称'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'successful'], 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success, and a value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Submit asynchronous Job', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:43.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'SubmitAsyncTask'], ], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitAsyncTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'SubmitAuditNote' => [ 'summary' => 'Model Studio provides the same feature as the Intelligent Proofreading module in Alibaba Cloud public cloud: uploading a custom rule library. Due to authentication restrictions, you must pass the file key (FileKey) of your custom rule library file as an input parameter to successfully call this API. After you call this API, Model Studio processes your custom rule library and returns a structured result in XLSX format. You can call GetAuditNoteProcessingStatus to check the processing status or call DownloadAuditNote to download the processed rule library. This API is under active development and will eventually accept a publicly accessible file URL instead of a FileKey.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of your Model Studio workspace. To get this ID, see [Get the Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The FileKey of your rule library file stored in Alibaba Cloud OSS. For how to generate a FileKey, see [Common APIs: GenerateUploadConfig for File Upload and Download](https://next.api.aliyun.com/document/AiMiaoBi/2023-08-01/GenerateUploadConfig?spm=openapi-amp.newDocPublishment.0.0.18fc281fOiiBil). Your rule library file must be in DOCX, XLSX, or PDF format. If you use XLSX, it must have exactly two columns. The table header must be "Proofreading Basis" and "Source". XLSX files give the best parsing results. DOCX and PDF files are also parsed automatically.', 'type' => 'string', 'required' => true, 'example' => 'oss://default/your/file/key'], ], [ 'name' => 'NoteId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'ID of the rule library. If you omit this parameter, the system uses Default.', 'type' => 'string', 'required' => false, 'example' => 'note_id_unique'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Task ID of this rule library submission. Use this ID in later API calls.', 'type' => 'string', 'example' => 'xxx_Default_89123748917'], ], 'example' => '', ], ], ], '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' => 'Submit Custom Rule Library', 'description' => 'All Model Studio products support iframe embedding. For details, see [Customer Integration: Model Studio Public Cloud iFrame Customization Guide](~~3000990~~).', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:SubmitAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitAuditTask' => [ 'summary' => 'Submits an audit task.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ArticleId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the article to be audited.', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The content to be audited.', 'type' => 'string', 'required' => false, 'example' => '待审核的内容'."\n" ."\n"], ], [ 'name' => 'HtmlContent', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The content to be audited, in HTML format.', 'type' => 'string', 'required' => false, 'example' => '待审核的内容（HTML格式）'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The title of the article to be audited.', 'type' => 'string', 'required' => false, 'example' => '审核时的文章标题'."\n" ."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The response object of the task.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The ID of the task.', 'type' => 'string', 'example' => 'xx'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Submit a review job ', 'description' => 'The Quanmiao product supports iframe embedding. For more information, see [Customer Integration: Quanmiao Public Cloud iframe Customization Plan](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' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitCustomHotTopicBroadcastJob' => [ 'summary' => 'You can submit a custom broadcast list job.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'HotTopicBroadcastConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The configuration for the news broadcast job.', 'title' => '', 'type' => 'object', 'properties' => [ 'StepForNewsBroadcastContentConfig' => [ 'description' => 'The configuration for the broadcast content.', 'title' => '', 'type' => 'object', 'properties' => [ 'Categories' => [ 'description' => 'The list of selected channels.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The channel.', 'type' => 'string', 'example' => '科技', 'required' => false, 'title' => ''], 'required' => false, 'example' => '["科技","经济","时政","娱乐"]', ], 'CustomHotValueWeights' => [ 'description' => 'The custom weights for hot topics.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The custom weight.', 'type' => 'object', 'properties' => [ 'Dimension' => ['title' => '', 'description' => 'The key of the dimension.', 'type' => 'string', 'example' => 'views', 'required' => false], 'DimensionName' => ['title' => '', 'description' => 'The name of the dimension.', 'type' => 'string', 'example' => '维度名称', 'required' => false], 'Weight' => ['title' => '', 'description' => 'The weight.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'TopicCount' => ['title' => '', 'description' => 'The number of topics.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], ], 'required' => true, 'example' => '', ], 'StepForCustomSummaryStyleConfig' => [ 'description' => 'The configuration for the custom output style.', 'title' => '', 'type' => 'object', 'properties' => [ 'SummaryImageCount' => ['title' => '', 'description' => 'The number of images in the summary.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'required' => false], 'SummaryModel' => ['title' => '', 'description' => 'The summary model.', 'type' => 'string', 'required' => false, 'example' => 'qwen-max'], 'SummaryPrompt' => ['title' => '', 'description' => 'The custom prompt for the summary.', 'type' => 'string', 'example' => 'xxxx', 'required' => false], ], 'required' => true, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'HotTopicVersion', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The version of the hot topic.', 'type' => 'string', 'example' => '热点版本', 'required' => false], ], [ 'name' => 'Topics', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The topic filter.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The name of the hot topic.', 'type' => 'string', 'required' => false, 'example' => '热点主题名称', 'title' => ''], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Submit a custom broadcast job', 'changeSet' => [ ['createdAt' => '2025-03-13T13:21:01.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitCustomHotTopicBroadcastJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitCustomSourceTopicAnalysis' => [ 'summary' => 'Submit topic trend analysis using a custom data source', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'FileUrl', 'in' => 'formData', 'schema' => ['description' => 'The file URL. You must specify either `FileUrl` or `News`. For details on the file structure, see the description of the `News` parameter.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://www.example.com/xxx.json'], ], [ 'name' => 'FileType', 'in' => 'formData', 'schema' => ['description' => 'The file type. Valid values: `json` (JSON array) and `jsonLine` (JSON Lines).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'json'], ], [ 'name' => 'MaxTopicSize', 'in' => 'formData', 'schema' => ['description' => 'The maximum number of topics to analyze. By default, the service sorts clustered news by count in descending order and analyzes the top 50 topics. The maximum value is 200.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '50'], ], [ 'name' => 'News', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of news articles. You must specify either `News` or `FileUrl`.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A news object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Title' => ['description' => 'The title of the news article.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '新闻标题'], 'Content' => ['description' => 'The content of the news article.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '新闻正文'."\n" ."\n"], 'Url' => ['description' => 'The URL of the news article.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://www.example.com/xxx.html'."\n"], 'Comments' => [ 'description' => 'A list of comments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A comment object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['description' => 'The comment text.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '评论内容'."\n" ."\n"], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'PubTime' => ['description' => 'The publication time. The format must be `YYYY-MM-dd HH:mm:ss`.', 'type' => 'string', 'example' => '2024-01-22 10:29:00', 'title' => '', 'required' => false], 'Source' => ['description' => 'The source of the news article.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '百度'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => '[The Model Studio workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'llm-xx'], ], [ 'name' => 'AnalysisTypes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The types of analysis for hot topic selection. Multiple values are supported. If you omit this parameter, the service analyzes all types by default. If you pass an empty array, the service performs only clustering and skips the analysis of hot topics for selection.'."\n" .'`HotViewPoints`: Analyzes perspectives on hot topics.'."\n" .'`WebReviewPoints`: Analyzes user viewpoints. This requires comments.'."\n" .'`TimedViewPoints`: Analyzes perspectives on timeliness.'."\n" .'`FreshViewPoints`: Analyzes novel perspectives.'."\n" .'`TopicSummary`: Summarizes news content.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'The type of analysis for hot topic selection.', 'type' => 'string', 'required' => false, 'example' => 'TimedViewPoints', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'Topics', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of topics.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A topic object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Topic' => ['description' => 'The topic name.', 'type' => 'string', 'example' => '话题名称', 'title' => '', 'required' => false], 'News' => [ 'description' => 'A list of news articles.', 'title' => '', 'type' => 'array', 'items' => ['description' => 'A news object.', '$ref' => '#/components/schemas/HottopicNews', 'title' => '', 'required' => false, 'example' => ''], 'required' => false, 'example' => '', ], 'CustomField' => ['description' => 'A custom field. You can use this field to filter results when you call the `ListHotTopics` operation.', 'type' => 'string', 'example' => 'xxx', 'maxLength' => 255, 'title' => '', 'required' => false], 'TopicUrl' => ['description' => 'The URL of the topic. This value is passed through to the `ListHotTopics` response without being processed.', 'type' => 'string', 'example' => 'https://www.example.com/topic/123', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'TopicsFileUrl', 'in' => 'formData', 'schema' => ['description' => 'The URL of the file that contains the topic list. The file must be in JSON Lines format, with each line representing a single JSON object.', 'type' => 'string', 'example' => 'http://www.example.com/xxx.jsonline', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Data' => [ 'description' => 'The data returned by the operation.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'The unique ID of the task.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'TaskName' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => '任务名称', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The message that describes the error.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates success. A value of `false` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Submit a topic selection analysis job from a Custom source ', 'requestParamsDescription' => 'Two analysis modes are available:'."\n" ."\n" .'1. Perform news clustering on a batch of articles, followed by topic planning analysis.'."\n" ."\n" .' 1. The analysis requires a news list object. See the `News` field for the object\'s structure.'."\n" ."\n" .' 2. Specify either the `News` field or the `fileUrl` field.'."\n" ."\n" .' 3. You can analyze up to 10,000 news articles per request.'."\n" ."\n" .' 4. The `MaxTopicSize` parameter controls the number of aggregated topics you can generate, up to a maximum of 200.'."\n" ."\n" .'2. Perform topic planning analysis directly on pre-clustered news.'."\n" ."\n" .' 1. The analysis requires a topic list object. See the `Topics` field for the object\'s structure.'."\n" ."\n" .' 2. Specify either the `Topics` field or the `TopicsFileUrl` field.'."\n" ."\n" .'3. You can export analysis results in JSON or Excel format. The `ExportType` field in the [export API](~~2929476~~) specifies the format.'."\n" ."\n" .'4. For guidance on best practices, see [Best Practices for Miaoce Custom Data Sources](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" .'The following example shows the `fileUrl` format:'."\n" ."\n" .'```json'."\n" ."\n" .'['."\n" .' {'."\n" .' "Content": "This is a sample article about artificial intelligence. Artificial intelligence is evolving fast and is widely used across many domains. From autonomous driving to medical diagnosis, AI is changing how we live.",'."\n" .' "Title": "Trends in artificial intelligence",'."\n" .' "Source": "Science and Technology Daily"'."\n" .' },'."\n" .' {'."\n" .' "Content": "As climate change becomes more severe, renewable energy has become a global focus. Advances in clean energy technologies such as solar and wind provide new ways to address environmental challenges.",'."\n" .' "Title": "The future of renewable energy",'."\n" .' "Source": "Environmental Weekly"'."\n" .' },'."\n" .' {'."\n" .' "Content": "The rollout of 5G creates new opportunities for the internet of things (IoT). Smart home and smart city concepts are moving from science fiction to reality and are changing how we interact with the world.",'."\n" .' "Title": "Integrated development of 5G and the internet of things",'."\n" .' "Source": "Communications World"'."\n" .' },'."\n" .' {'."\n" .' "Content": "As health awareness grows, the fitness industry is expanding fast. From traditional gyms to new online fitness platforms, diverse exercise options meet the needs of different groups.",'."\n" .' "Title": "The rise of the fitness industry",'."\n" .' "Source": "Healthy Living"'."\n" .' },'."\n" .' {'."\n" .' "Content": "The rise of short video platforms has changed how people consume content. Users get information and entertainment through short clips. This fragmented distribution model has had a deep impact on traditional media.",'."\n" .' "Title": "Content shifts in the short video era",'."\n" .' "Source": "Media Watch"'."\n" .' }'."\n" .']'."\n" .'```', 'changeSet' => [ ['createdAt' => '2025-06-26T12:18:54.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitCustomSourceTopicAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'SubmitCustomTopicSelectionPerspectiveAnalysisTask' => [ 'summary' => 'Submits a custom analysis task to analyze hot topic perspectives.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Documents', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'maxItems' => 30, 'description' => 'The list of documents to be analyzed.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'The author.', 'type' => 'string', 'example' => '作者', 'maxLength' => 100, 'required' => false], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'required' => true, 'example' => '文章内容', 'maxLength' => 3000, 'minLength' => 30], 'PubTime' => ['title' => '', 'description' => 'The publication time. Format: YYYY-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-01-22 10:29:00', 'maxLength' => 19, 'required' => false], 'Source' => ['title' => '', 'description' => 'The source of the article.', 'type' => 'string', 'example' => '新浪', 'maxLength' => 40, 'required' => false], 'Summary' => ['title' => '', 'description' => 'The summary.', 'type' => 'string', 'example' => '文章摘要', 'maxLength' => 200, 'required' => false], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题', 'maxLength' => 100, 'required' => false], 'Url' => ['title' => '', 'description' => 'The URL of the article.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx', 'maxLength' => 1024, 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the topic to be analyzed.', 'type' => 'string', 'example' => '待分析的主题名（documents与topic二者至少传一个）', 'maxLength' => 1000, 'required' => false], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The input prompt for custom perspectives.', 'type' => 'string', 'required' => true, 'example' => '自定义观点的输入Prompt', 'maxLength' => 2000], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error description.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Submit a Custom hot spot topic perspective Analysis Job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitCustomTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitDeepWriteTask' => [ 'summary' => 'You can submit a deep writing task. You can provide information such as questions, instructions, and attachments, based on the topic you want to research or analyze. The system schedules and executes this task in the background.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[The workspace ID.](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'llm-1setzb9xb8m11vrc'], ], [ 'name' => 'Input', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The user\'s question.', 'type' => 'string', 'required' => true, 'example' => '北京2025年新能源汽车发展趋势'], ], [ 'name' => 'Instructions', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The instructions.', 'type' => 'string', 'required' => false, 'example' => '请根据北京新能源汽车在汽车品牌、新车发布、能源等方面进行分析'], ], [ 'name' => 'Files', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'A list of attachments.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'FileKey' => ['title' => '', 'description' => 'The Object Storage Service (OSS) address of the attachment.', 'type' => 'string', 'example' => 'oss://default/aimiaobi-poc/aimiaobi/deep-write-upload/1_1/xxx.txt', 'maxLength' => 500, 'required' => false], 'FileDescription' => ['title' => '', 'description' => 'A description of the attachment.', 'type' => 'string', 'example' => '附件的说明', 'maxLength' => 500, 'required' => false], 'FileName' => ['title' => '', 'description' => 'The name of the attachment.', 'type' => 'string', 'example' => '附件的名称', 'maxLength' => 200, 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'AgentOrchestration', 'in' => 'query', 'style' => 'json', 'schema' => [ 'description' => 'The agent orchestration options.', 'type' => 'object', 'properties' => [ 'DataCollectorAgent' => [ 'description' => 'The data collection agent.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name.', 'type' => 'string', 'default' => 'DataCollectorAgent', 'required' => false, 'example' => 'DataCollectorAgent', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'DataAnalystAgent' => [ 'description' => 'The data analysis agent.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name.', 'type' => 'string', 'default' => 'DataAnalystAgent', 'required' => false, 'example' => 'DataAnalystAgent', 'title' => ''], 'EnableSearch' => ['description' => 'Specifies whether to enable retrieval.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'ReporterAgent' => [ 'description' => 'The reporter agent.', 'type' => 'object', 'properties' => [ 'Name' => ['description' => 'The name.', 'type' => 'string', 'default' => 'ReporterAgent', 'required' => false, 'example' => 'ReporterAgent', 'title' => ''], 'EnableCitation' => ['description' => 'Specifies whether to enable citations.', 'type' => 'boolean', 'required' => false, 'title' => '', 'example' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response schema.', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'The task response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => 'xbabac91-fdad-44d6-95ce-******'], 'Status' => [ 'title' => '', 'description' => 'The status of the task.', 'enumValueTitles' => ['in_progress' => 'In progress', 'queued' => 'Queued', 'cancelled' => 'Canceled', 'completed' => 'Completed', 'failed' => 'Failed'], 'type' => 'string', 'example' => 'queued', ], ], 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Submit a depth writing job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitDeepWriteTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitDocClusterTask' => [ 'summary' => 'Submits a content clustering task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique ID of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Documents', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'minItems' => 2, 'maxItems' => 10000, 'description' => 'A list of documents.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Content' => ['title' => '', 'description' => 'The content of the document.', 'type' => 'string', 'required' => true, 'example' => '文档内容', 'maxLength' => 3000, 'minLength' => 1], 'DocId' => ['title' => '', 'description' => 'The document ID. It is used to identify the document in the returned cluster results. If you do not provide an ID for any document, the array index is used instead. An error is reported if you provide IDs for only some of the documents.', 'type' => 'string', 'example' => '文档ID。用于在返回聚类文章时标识文章。如果文章列表中都不传则使用数组索引作为ID。如果部分传则会报错', 'required' => false], 'Title' => ['title' => '', 'description' => 'The title of the document.', 'type' => 'string', 'example' => '文档标题', 'maxLength' => 100, 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], [ 'name' => 'TopicCount', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The maximum number of clusters.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'example' => '15', 'required' => false], ], [ 'name' => 'TitleLength', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The character limit for the generated cluster title.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'example' => '69', 'required' => false], ], [ 'name' => 'SummaryLength', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The character limit for the generated cluster summary.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '500', 'example' => '49', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The data returned.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The unique ID of the task.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Submit a content aggregation job', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitDocClusterTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitEnterpriseVocAnalysisTask' => [ 'summary' => 'Submits a Voice of the Customer (VOC) asynchronous task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the Model Studio workspace. For more information, see [Get a workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The key of the file.', 'type' => 'string', 'required' => false, 'example' => 'oss://default/bucket-name/materialDocument/tenant_agent/fileName'], ], [ 'name' => 'MaterialType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The material type. Valid values: \\`shortContent\\` (long or short comments, or tickets) and \\`dialogue\\` (dialogues).', 'type' => 'string', 'required' => false, 'example' => 'shortContent'], ], [ 'name' => 'ModelId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The ID of the model.', 'type' => 'string', 'required' => true, 'example' => 'qwen-max'], ], [ 'name' => 'ContentTags', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The content tags.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A content tag object.', 'type' => 'object', 'properties' => [ 'TagName' => ['title' => '', 'description' => 'The tag name.', 'type' => 'string', 'example' => '一级标签-二级标签', 'required' => false], 'TagValueDefinePrompt' => ['title' => '', 'description' => 'The definition of the tag value. For a tag mining task, this is a comma-separated list of enumerated values. For a summarization task, this is the summarization prompt.', 'type' => 'string', 'example' => '是,否', 'required' => false], 'TagDefinePrompt' => ['title' => '', 'description' => 'The tag definition.', 'type' => 'string', 'example' => '一级标签-二级标签', 'required' => false], 'TagTaskType' => ['title' => '', 'description' => 'The type of the tag mining task. Valid values: \\`singleTagValue\\` (single tag), \\`multiTagValues\\` (multiple tags), \\`summaryAndOverview\\` (summarization and overview), and \\`filter\\` (filtering).', 'type' => 'string', 'example' => 'singleTagValue', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], ], [ 'name' => 'FilterTags', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The filter tags.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A filter tag object.', 'type' => 'object', 'properties' => [ 'TagName' => ['title' => '', 'description' => 'The tag name.', 'type' => 'string', 'example' => '一级标签-二级标签', 'required' => false], 'TagValueDefinePrompt' => ['title' => '', 'description' => 'The definition of the tag value. For a tag mining task, this is a comma-separated list of enumerated values. For a summarization task, this is the summarization prompt.', 'type' => 'string', 'example' => '是,否'."\n", 'required' => false], 'TagDefinePrompt' => ['title' => '', 'description' => 'The tag definition.', 'type' => 'string', 'example' => '一级标签-二级标签', 'required' => false], 'TagType' => ['title' => '', 'description' => 'The type of the tag mining task. Valid values: \\`singleTagValue\\` (single tag), \\`multiTagValues\\` (multiple tags), \\`summaryAndOverview\\` (summarization and overview), and \\`filter\\` (filtering).', 'type' => 'string', 'example' => 'singleTagValue', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'PositiveSample', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The content of the positive sample.', 'type' => 'string', 'required' => false, 'example' => '正面样本'], ], [ 'name' => 'PositiveSampleFileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The key of the positive sample file.', 'type' => 'string', 'required' => false, 'example' => 'oss://default/bucket-name/path/xxx.xlsx'], ], [ 'name' => 'TaskType', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The task type. Valid values: \\`lightAppSass\\` (invoked from a Software as a Service (SaaS) page) and \\`sdkBatchTask\\` (SDK batch task).', 'type' => 'string', 'required' => false, 'example' => 'lightAppSass'], ], [ 'name' => 'Contents', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The material content to be mined.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'A material content object to be mined.', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'The material to be mined.', 'type' => 'string', 'required' => false, 'example' => '内容文本'], 'ExtraInfo' => ['title' => '', 'description' => 'Additional information provided directly to the large language model (LLM).', 'type' => 'string', 'required' => false, 'example' => '额外信息'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ApiKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The API key for integration access. For more information, see [Get an API key](https://help.aliyun.com/zh/model-studio/get-api-key?spm=a2c4g.11186623.help-menu-2400256.d_2_0_0.1cbdb0a8lsT1n3).', 'type' => 'string', 'required' => false, 'example' => 'sk-sdfs2-wewerwe-ere'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The template validation results.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The ID of the task.', 'type' => 'string', 'example' => 'xxxxx'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success, and \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Submit an enterprise VOC analysis job', 'changeSet' => [ ['createdAt' => '2025-04-17T12:39:56.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:SubmitEnterpriseVocAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitExportTermsTask' => [ 'summary' => 'Export task for a thesaurus', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'TermsName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the dictionary. Optional. If you do not specify a value, the default name is used.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'ID of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Submit export term library job', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:SubmitExportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitFactAuditUrl' => [ 'summary' => 'MiaoBi provides a factuality audit capability that verifies facts using web search and supports custom configuration of search source URLs.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. To get the workspace ID, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'Url', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The URL of the information source you want to use for factuality audit. After you add a source URL using this operation, MiaoBi retrieves audit information only from your configured list of URLs. If you do not add any URL, MiaoBi searches the entire web for audit information. You can configure up to 10 source URLs.', 'type' => 'string', 'required' => true, 'example' => 'https://aliyun.com'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Response schema', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => ['title' => '', 'description' => 'Confirmation that the URL was added successfully', 'type' => 'string', 'example' => 'SUCCESSED'], ], 'example' => '', ], ], ], '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\\": \\"SUCCESSED\\"\\n}","type":"json"}]', 'title' => 'Submit Factuality Review URL ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitFactAuditUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitImportTermsTask' => [ 'summary' => 'Submit a custom dictionary import task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Alibaba Cloud Model Studio unique workspace identifier: For more information, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'llm-xx'], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'File Key.', 'type' => 'string', 'required' => true, 'example' => 'oss://default/oss-bucket-name/aimiaobi/2021/07/01/1625126400000/1.docx'], ], [ 'name' => 'TermsName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Dictionary name. Optional. If not specified, the default is Default.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F2F366D6-E9FE-1006-BB70-2C650896AAB5'], 'Success' => ['title' => '', 'description' => 'Indicates whether this request was successful.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error description.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Submit a vocabulary import job', 'requestParamsDescription' => '>'."\n" ."\n" .'For information about how to generate a FileKey, see [the General API - File Upload and Download GenerateUploadConfig documentation](https://help.aliyun.com/zh/model-studio/api-aimiaobi-2023-08-01-generateuploadconfig)'."\n" ."\n" .'>', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:SubmitImportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitParseDocumentLayoutTask' => [ 'summary' => '', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => 'llm-xx'], ], [ 'name' => 'Content', 'in' => 'query', 'schema' => ['type' => 'string', 'required' => true, 'title' => '', 'description' => '', 'example' => '正文'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Success' => ['type' => 'boolean', 'description' => '', 'example' => 'true', 'title' => ''], 'Code' => ['type' => 'string', 'description' => '', 'example' => 'successful', 'title' => ''], 'HttpStatusCode' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'example' => '200', 'title' => ''], 'Message' => ['type' => 'string', 'description' => '', 'example' => 'success', 'title' => ''], 'Data' => [ 'type' => 'object', 'properties' => [ 'TaskId' => ['type' => 'string', 'description' => '', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => '', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], '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"}]', ], 'SubmitSmartAudit' => [ 'summary' => 'Submit a smart audit request.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => '[Workspace ID](~~2782167~~)', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], [ 'name' => 'Text', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content to be audited', 'type' => 'string', 'required' => false, 'example' => '“你好呀”'], ], [ 'name' => 'SubCodes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'List of sub-audit codes', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Sub-audit code. For a full list of sub-audit codes, see the [ListAuditContentErrorTypes](~~2929521~~) API or the parameter notes below.', 'type' => 'string', 'required' => false, 'example' => 'PunctuationError'], 'required' => false, 'title' => '', 'example' => '', ], ], [ 'name' => 'imageUrls', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Parameters for image audit (deprecated; use ImageUrlList instead)', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Parameters for image audit', 'type' => 'object', 'properties' => [ 'url' => ['title' => '', 'description' => 'The URL can be a web link or a base64-encoded string.', 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com/xxx.jpg'], 'id' => ['title' => '', 'description' => 'Unique image identifier', 'type' => 'string', 'required' => false, 'example' => '3HAZTv62M0vkyz5B'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ImageUrlList', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Parameters for image audit', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The URL can be a web link or a base64-encoded string.', 'type' => 'string', 'required' => false, 'example' => 'http://www.example.com/xxx.png'], 'Id' => ['title' => '', 'description' => 'Unique image identifier', 'type' => 'string', 'required' => false, 'example' => 'xxxx'], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'NoteId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Rule library ID for rule-based auditing (default: Default)', 'type' => 'string', 'required' => false, 'example' => 'note_1_486'], ], [ 'name' => 'TermsName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Word library name for dictionary-based auditing (default: Default)', 'type' => 'string', 'required' => false, 'example' => 'Default'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'Schema of Response', 'title' => '', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => 'xxxxx'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Error code', 'type' => 'string', 'example' => 'DataNotExists'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => '错误消息'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ 'description' => 'Task response object', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Task ID', 'type' => 'string', 'example' => 'xxxx'], ], 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Submit an Intelligent Review job', 'description' => 'The Quanmiao product supports iframe embedding. For more information, see [Customer integration: Quanmiao public cloud iframe customization guide](~~3000990~~).'."\n" ."\n" .'# Supported audit types'."\n" ."\n" .'## Audit category overview'."\n" ."\n" .'| Audit category | Description |'."\n" .'| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" .'| Content accuracy | Errors due to phonetic or visual similarity; punctuation errors; misuse of Chinese structural particles (的/地/得); inappropriate word choice or syntax errors; incorrect personal names; incorrect place names; incorrect references; errors in proper nouns or terminology |'."\n" .'| Formatting issues | Inconsistent capitalization; numeric errors; nonstandard units of measurement; use of traditional Chinese characters |'."\n" .'| Content structure issues | Redundant text; repeated segments; logical contradictions; unfilled placeholders |'."\n" .'| Political sensitivity issues | Sensitive content or directional risks; name or sorting errors; conventional phrasing errors; nonstandard institutional names; misquoting important speeches; references to disgraced officials; mismatched name-title pairings; incorrect title expressions |'."\n" .'| Security and compliance issues | Violence or terrorism; pornography; prohibited content; insults; disgraced celebrities; personal privacy violations; reporting standard violations |'."\n" .'| Legal errors | Incorrect citation of laws and regulations; errors in legal provisions |'."\n" .'| Other domain-specific errors | Violations of advertising law; financial information errors; scientific or technical term errors |'."\n" .'| Factuality check | Factuality verification: correct or incorrect items |'."\n" .'| Image audit | Image content moderation |'."\n" .'| Custom word library | Custom word library audit |'."\n" .'| Rule library audit | Rule library audit |'."\n" .'| English proofreading | Terminology standardization; verb tense accuracy; punctuation and quotation marks; spelling and language variants; sentence structure and clarity; numeric and percentage formatting; standardized phrasing |'."\n" ."\n" .'***'."\n" ."\n" .'## Sub-audit code values'."\n" ."\n" .'### 1. Content accuracy'."\n" ."\n" .'| Description | Code |'."\n" .'| ---------------------------------------------- | -------------------- |'."\n" .'| Phonetic or visual similarity errors | PhoneticSimilarError |'."\n" .'| Punctuation errors | PunctuationError |'."\n" .'| Misuse of Chinese structural particles (的/地/得) | ParticleUsageError |'."\n" .'| Inappropriate word choice or syntax errors | WordError |'."\n" .'| Incorrect personal names | PersonNameError |'."\n" .'| Incorrect place names | LocationError |'."\n" .'| Incorrect references | ReferenceError |'."\n" .'| Errors in proper nouns or terminology | NounItemError |'."\n" ."\n" .'### 2. Formatting issues'."\n" ."\n" .'| Description | Code |'."\n" .'| ------------------------------------- | ----------------------- |'."\n" .'| Inconsistent capitalization | CapitalizationError |'."\n" .'| Numeric errors | NumberError |'."\n" .'| Nonstandard units of measurement | UnitError |'."\n" .'| Use of traditional Chinese characters | TraditionalChineseError |'."\n" ."\n" .'### 3. Content structure issues'."\n" ."\n" .'| Description | Code |'."\n" .'| ---------------------- | -------------------- |'."\n" .'| Redundant text | WordRedundancy |'."\n" .'| Repeated segments | DuplicateError |'."\n" .'| Logical contradictions | LogicContradiction |'."\n" .'| Unfilled placeholders | PlaceholderNotFilled |'."\n" ."\n" .'### 4. Political sensitivity issues'."\n" ."\n" .'| Description | Code |'."\n" .'| -------------------------------------- | --------------------------- |'."\n" .'| Sensitive content or directional risks | SensitiveContentRisk |'."\n" .'| Name or sorting errors | NameOrderError |'."\n" .'| Conventional phrasing errors | ConventionalExpressionError |'."\n" .'| Nonstandard institutional names | DepartmentNameError |'."\n" .'| Misquoting important speeches | ImportantSpeechError |'."\n" .'| References to disgraced officials | FallenOfficialError |'."\n" .'| Mismatched name-title pairings | LeaderTitleMatchError |'."\n" .'| Incorrect title expressions | TitleError |'."\n" ."\n" .'### 5. Security and compliance issues'."\n" ."\n" .'| Description | Code |'."\n" .'| ----------------------------- | ---------------------- |'."\n" .'| Violence or terrorism | ViolenceTerrorismError |'."\n" .'| Pornography | PornographyError |'."\n" .'| Prohibited content | ProhibitedContentError |'."\n" .'| Insults | InsultError |'."\n" .'| Disgraced celebrities | DisgracedArtistError |'."\n" .'| Personal privacy violations | PersonalPrivacyError |'."\n" .'| Reporting standard violations | ReportingStandardError |'."\n" ."\n" .'### 6. Legal errors'."\n" ."\n" .'| Description | Code |'."\n" .'| ------------------------------------------ | -------------------- |'."\n" .'| Incorrect citation of laws and regulations | LegalReferenceError |'."\n" .'| Errors in legal provisions | LegalProvisionsError |'."\n" ."\n" .'### 7. Other domain-specific errors'."\n" ."\n" .'| Description | Code |'."\n" .'| ----------------------------------- | ------------------------------- |'."\n" .'| Violations of advertising law | AdvertisingProhibitedWordsError |'."\n" .'| Financial information errors | FinancialInformationError |'."\n" .'| Scientific or technical term errors | TechnicalTermError |'."\n" ."\n" .'### 8. Factuality check'."\n" ."\n" .'| Description | Code |'."\n" .'| ---------------------------------------- | -------------- |'."\n" .'| Factuality verification – correct item | CorrectFact |'."\n" .'| Factuality verification – incorrect item | WrongFactError |'."\n" ."\n" .'### 9. Image audit'."\n" ."\n" .'| Description | Code |'."\n" .'| ----------- | ---------- |'."\n" .'| Image audit | ImageAudit |'."\n" ."\n" .'### 10. Custom word library'."\n" ."\n" .'| Description | Code |'."\n" .'| ------------------- | ----------- |'."\n" .'| Custom word library | WordLibrary |'."\n" ."\n" .'### 11. Rule library audit'."\n" ."\n" .'| Description | Code |'."\n" .'| ------------------ | ----------------- |'."\n" .'| Rule library audit | WrongQuestionBook |'."\n" ."\n" .'### 12. English proofreading'."\n" ."\n" .'| Description | Code |'."\n" .'| --------------------------------- | ---------------------------- |'."\n" .'| Terminology standardization | TerminologyNormalisation |'."\n" .'| Verb tense accuracy | VerbTenseAccuracy |'."\n" .'| Punctuation and quotation marks | PunctuationAndQuotationMarks |'."\n" .'| Spelling and language variants | SpellingAndLanguageVariety |'."\n" .'| Sentence structure and clarity | SentenceStructureAndClarity |'."\n" .'| Numeric and percentage formatting | NumericAndPercentageStyle |'."\n" .'| Other standardized phrasing | Others |', 'changeSet' => [ ['createdAt' => '2025-11-11T11:58:34.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-08-04T11:57:09.000Z', 'description' => 'Request parameters changed'], ['createdAt' => '2025-07-15T12:23:57.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitSmartAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitSmartClipTask' => [ 'summary' => 'Submits a one-click video editing task.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Alibaba Cloud Model Studio workspace ID. For more information, see [workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => '业务空间ID'], ], [ 'name' => 'InputConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Input configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'VideoIds' => [ 'description' => 'List of video material ID objects.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Material ID object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'ID type:'."\n" .'materialId: Material Library reference ID'."\n" .'fileKey: FileKey in Alibaba Cloud Model Studio'."\n" .'url: Publicly accessible URL', 'type' => 'string', 'required' => true, 'example' => 'fileKey'], 'Id' => ['title' => '', 'description' => 'Material ID.', 'type' => 'string', 'required' => true, 'example' => 'oss://default/bucket-name/filepath/video.mp4'], ], 'required' => false, 'example' => '', ], 'required' => true, 'example' => '', ], 'Titles' => [ 'description' => 'List of titles.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Title.', 'type' => 'string', 'required' => false, 'example' => '视频标题'], 'required' => false, 'example' => '', ], 'BackgroundMusics' => [ 'description' => 'List of background music IDs.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Background music ID object.', 'title' => '', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'ID type:'."\n" .'materialId: Material Library reference ID'."\n" .'fileKey: FileKey in Alibaba Cloud Model Studio'."\n" .'url: Publicly accessible URL', 'type' => 'string', 'required' => true, 'example' => 'fileKey'], 'Id' => ['title' => '', 'description' => 'Background music ID.', 'type' => 'string', 'required' => true, 'example' => 'oss://default/bucket-name/filepath/video.mp3'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'Stickers' => [ 'description' => 'List of stickers.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Sticker object.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'X coordinate of the top-left corner of the sticker.', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'], 'Y' => ['title' => '', 'description' => 'Y coordinate of the top-left corner of the sticker.', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'], 'Width' => ['title' => '', 'description' => 'Width of the sticker.', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'], 'Height' => ['title' => '', 'description' => 'Height of the sticker.', 'type' => 'number', 'format' => 'double', 'required' => true, 'example' => '0.5'], 'StickerId' => [ 'description' => 'Sticker ID.', 'title' => '', 'type' => 'object', 'properties' => [ 'Type' => ['title' => '', 'description' => 'ID type:'."\n" .'materialId: Material Library reference ID'."\n" .'fileKey: FileKey in Alibaba Cloud Model Studio'."\n" .'url: Publicly accessible URL', 'type' => 'string', 'required' => true, 'example' => 'fileKey'], 'Id' => ['title' => '', 'description' => 'Sticker ID.', 'type' => 'string', 'required' => true, 'example' => 'oss://default/bucket-name/filepath/sticker.png'], ], 'required' => true, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'SpeechTexts' => [ 'description' => 'List of voiceover script texts.', 'title' => '', 'type' => 'array', 'items' => ['title' => '', 'description' => 'Voiceover script text.', 'type' => 'string', 'required' => false, 'example' => '大家好，欢迎来到我的频道xxx'], 'required' => false, 'example' => '', ], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'OutputConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Output configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'FileName' => ['title' => '', 'description' => 'Output file name. Must include {index}.', 'type' => 'string', 'required' => false, 'example' => 'test_{index}.mp4', 'pattern' => '.*\\{index\\}.*'], 'Width' => ['title' => '', 'description' => 'Output video width.', 'type' => 'integer', 'format' => 'int32', 'example' => '1920', 'required' => false], 'Height' => ['title' => '', 'description' => 'Output video height.', 'type' => 'integer', 'format' => 'int32', 'example' => '1080', 'required' => false], 'Count' => ['title' => '', 'description' => 'Number of output videos.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], 'MaxDuration' => ['title' => '', 'description' => 'Maximum duration of the output video, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '120', 'required' => false], 'SaveToGeneratedContent' => ['title' => '', 'description' => 'Save to Content Management.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'EditingConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Video editing configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'TitleConfig' => [ 'description' => 'Title configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'Horizontal distance from the top-left corner of the banner text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video width. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'required' => false], 'Y' => ['title' => '', 'description' => 'Vertical distance from the top-left corner of the banner text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video height. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.', 'type' => 'number', 'format' => 'float', 'example' => '100', 'required' => false], 'TimelineIn' => ['title' => '', 'description' => 'Time when the title appears.', 'type' => 'number', 'format' => 'float', 'example' => '2', 'required' => false], 'TimelineOut' => ['title' => '', 'description' => 'Time when the title disappears.', 'type' => 'number', 'format' => 'float', 'example' => '3', 'required' => false], 'Alignment' => ['title' => '', 'description' => 'TopLeft: Top-left corner of the video.'."\n" .'TopCenter: Top center of the vertical axis of the video.'."\n" .'TopRight: Top-right corner of the video.'."\n" .'CenterLeft: Left side of the horizontal center line of the video.'."\n" .'CenterCenter: Center of the video.'."\n" .'CenterRight: Right side of the horizontal center line of the video.'."\n" .'BottomLeft: Bottom-left corner of the video.'."\n" .'BottomCenter: Bottom center of the vertical axis of the video.'."\n" .'BottomRight: Bottom-right corner of the video.', 'type' => 'string', 'example' => 'TopLeft', 'required' => false], ], 'required' => false, 'example' => '', ], 'MediaConfig' => [ 'description' => 'Media configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Volume' => ['title' => '', 'description' => 'Volume of the video material. 0 means mute.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], 'SpeechConfig' => [ 'description' => 'Voiceover configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Volume' => ['title' => '', 'description' => 'Volume of the voiceover audio. Default value: 1. Valid values: 0 to 10.0. Decimal values are supported. Example: 0.5.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'default' => '1', 'required' => false], 'Voice' => ['title' => '', 'description' => 'Specify one or more voice styles for the voiceover, separated by commas. When multiple voices are specified, one is randomly selected for synthesis. For available voice styles, see [Smart Voice Effect Examples](https://help.aliyun.com/zh/ims/developer-reference/smart-voice-effect-example?spm=a2c4g.11186623.0.0.13091ee6Pw4Jqz). Example: "zhimiao\\_emo,zhilun".', 'type' => 'string', 'required' => false, 'example' => ''], 'Style' => ['title' => '', 'description' => 'Voiceover style. Default value: empty. If both Voice and Style are specified, Voice takes precedence.'."\n" .'Gentle: Gentle'."\n" .'Serious: Serious'."\n" .'Entertainment: Entertainment', 'type' => 'string', 'required' => false, 'example' => ''], 'SpeechRate' => ['title' => '', 'description' => 'Speech rate of the voiceover script.'."\n" .'Valid values: -500 to 500. Default value: 0.'."\n" .'The corresponding playback speed multipliers for \\[-500, 0, 500] are \\[0.5, 1.0, 2.0].'."\n" .'Calculation method:'."\n" .'For 0.8× speed: (1 - 1/0.8) / 0.002 = -125'."\n" .'For 1.2× speed: (1 - 1/1.2) / 0.001 = 166'."\n" .'Use coefficient 0.002 for speeds less than 1×.'."\n" .'Use coefficient 0.001 for speeds greater than 1×.'."\n" .'Round the result to the nearest integer.'."\n" ."\n" .'The calculation method is as follows:
'."\n" .'0.8× speed: (1 − 1/0.8)/0.002 = −125
'."\n" .'1.2× speed: (1 − 1/1.2)/0.001 = 166
'."\n" .'When the speed is less than 1×, use a coefficient of 0.002.
'."\n" .'When the speed is greater than 1×, use a coefficient of 0.001.
'."\n" .'The actual algorithm result is approximated.




', 'type' => 'number', 'format' => 'double', 'example' => '0', 'default' => '0', 'required' => false], 'AsrConfig' => [ 'description' => 'Caption parameter configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'X' => ['title' => '', 'description' => 'Horizontal distance from the top-left corner of the caption text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video width. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => ''], 'Y' => ['title' => '', 'description' => 'Vertical distance from the top-left corner of the caption text to the top-left corner of the output video. You can specify this value as a percentage or in pixels. If the value is between 0 and 0.9999, it represents a percentage of the output video height. If the value is an integer greater than or equal to 2, it represents an absolute pixel value. Default value: 0. This coordinate scales based on the source material size and the final output size.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => ''], 'Alignment' => ['title' => '', 'description' => 'Caption alignment.'."\n" .'TopLeft: Top-left corner of the video.'."\n" .'TopCenter: Top center of the vertical axis of the video.'."\n" .'TopRight: Top-right corner of the video.'."\n" .'CenterLeft: Left side of the horizontal center line of the video.'."\n" .'CenterCenter: Center of the video.'."\n" .'CenterRight: Right side of the horizontal center line of the video.'."\n" .'BottomLeft: Bottom-left corner of the video.'."\n" .'BottomCenter: Bottom center of the vertical axis of the video.'."\n" .'BottomRight: Bottom-right corner of the video.', 'type' => 'string', 'required' => false, 'example' => ''], 'Font' => ['title' => '', 'description' => 'Font of the caption text. For supported fonts, see the font list. Default font: SimSun.', 'type' => 'string', 'example' => 'SimSun', 'default' => 'SimSun', 'required' => false], 'FontColor' => ['title' => '', 'description' => 'Color of the caption text. Format: # followed by a hexadecimal value. Example: #ffffff.', 'type' => 'string', 'example' => '#ffffff', 'default' => '#ffffff', 'required' => false], 'FontSize' => ['title' => '', 'description' => 'Font size of the caption text. This size scales based on the source material size and the final output size. Default value: 0. Maximum value: 5000.', 'type' => 'string', 'example' => '0', 'default' => '0', 'required' => false], 'Spacing' => ['title' => '', 'description' => 'Letter spacing of the caption text, in pixels.', 'type' => 'string', 'required' => false, 'example' => '0'], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], 'BackgroundMusicConfig' => [ 'description' => 'Background music configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Volume' => ['title' => '', 'description' => 'Volume of the background music. Valid values: 0 to 10.0.', 'type' => 'number', 'format' => 'double', 'example' => '0.2', 'default' => '0.2', 'required' => false], 'Style' => ['title' => '', 'description' => 'Background music style. Default value: empty. If background music is already configured in InputConfig, this field does not take effect.'."\n" .'Valid values:'."\n" .'bgm-beauty: Fashion'."\n" .'bgm-chinese-style: Chinese style'."\n" .'bgm-cuisine: Food'."\n" .'bgm-dynamic: Dynamic'."\n" .'bgm-quirky: Quirky'."\n" .'bgm-relaxing: Relaxing'."\n" .'bgm-romantic: Romantic'."\n" .'bgm-upbeat: Upbeat', 'type' => 'string', 'required' => false, 'example' => ''], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'ExtendParam', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Additional extended parameters. These parameters merge with InputConfig, OutputConfig, and EditingConfig.', 'type' => 'string', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'The result of the task submission.', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'The task ID.', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. true indicates success. false indicates failure.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], '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' => 'Submit an Intelligent One-Click Video Editing Job', 'changeSet' => [ ['createdAt' => '2025-01-02T11:56:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitSmartClipTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'SubmitTopicSelectionPerspectiveAnalysisTask' => [ 'summary' => 'Submits a hot spot analysis task for topic selection.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Documents', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'maxItems' => 30, 'description' => 'The list of documents to be analyzed. (Provide at least one of documents or topic)', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Document list information', 'type' => 'object', 'properties' => [ 'Author' => ['title' => '', 'description' => 'Author', 'type' => 'string', 'example' => '作者', 'maxLength' => 100, 'required' => false], 'Comments' => [ 'description' => 'Content list', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'Object', 'title' => '', 'type' => 'object', 'properties' => [ 'Text' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'required' => false, 'example' => '内容'], 'Username' => ['title' => '', 'description' => 'Username', 'type' => 'string', 'required' => false, 'example' => '用户名'], ], 'required' => false, 'example' => '', ], 'required' => false, 'example' => '', ], 'Content' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'required' => true, 'example' => '文章内容', 'maxLength' => 3000, 'minLength' => 30], 'PubTime' => ['title' => '', 'description' => 'Publication time. Format: YYYY-MM-dd HH:mm:ss', 'type' => 'string', 'example' => '2024-01-22 10:29:00', 'maxLength' => 19, 'required' => false], 'Source' => ['title' => '', 'description' => 'Article source', 'type' => 'string', 'example' => '新浪', 'maxLength' => 40, 'required' => false], 'Summary' => ['title' => '', 'description' => 'Summary', 'type' => 'string', 'example' => '文章摘要', 'maxLength' => 200, 'required' => false], 'Title' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '文章标题', 'maxLength' => 100, 'required' => false], 'Url' => ['title' => '', 'description' => 'Article URL', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx', 'maxLength' => 1024, 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], [ 'name' => 'Topic', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The name of the topic to be analyzed. (Provide at least one of documents or topic)', 'type' => 'string', 'example' => '待分析的主题名（documents与topic二者至少传一个）', 'maxLength' => 1000, 'required' => false], ], [ 'name' => 'PerspectiveTypes', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The topic selection perspective tasks to be analyzed. By default, this parameter is empty, which means all tasks are analyzed. (TopicSummary: Topic event summary, HotViewPoints: Hot topic selection perspectives, TimedViewPoints: Timeliness topic selection perspectives, WebReviewPoints: Online review topic selection perspectives, FreshViewPoints: Novel topic selection perspectives)', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The topic selection perspective task to be analyzed', 'type' => 'string', 'enum' => ['TopicSummary', 'HotViewPoints', 'TimedViewPoints', 'WebReviewPoints', 'FreshViewPoints'], 'required' => false, 'example' => 'TopicSummary', 'title' => '', ], 'required' => false, 'example' => 'TimedViewPoints', ], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => [ 'description' => 'Business data', 'title' => '', 'type' => 'object', 'properties' => [ 'TaskId' => ['title' => '', 'description' => 'Unique task ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'TaskName' => ['title' => '', 'description' => 'Task name', 'type' => 'string', 'example' => '任务名称'], ], 'example' => '', ], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Error message', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Unique request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Success or failure: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Submit a topic hot spot analysis job', 'changeSet' => [ ['createdAt' => '2024-10-12T07:31:26.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'SubmitVideoAudit' => [ 'summary' => 'Submits a video for review.', 'description' => 'Quanmiao products support iframe embedding. For more information, see [Customer Integration\\_Quanmiao Public Cloud iframe Customization Solution](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).', 'path' => '/quanmiao/aimiaobi/pop/videoAudit/submitVideoAudit', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'paid', 'autoTest' => true, 'tenantRelevance' => 'tenant'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Workspace ID', 'type' => 'string', 'required' => true, 'example' => 'llm-xxxxx', 'title' => ''], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['description' => 'Unique file identity within the Miaobi system (choose either FileKey or URL)', 'type' => 'string', 'example' => 'oss://default/xxx/video/test.mp4', 'title' => '', 'required' => false], ], [ 'name' => 'Url', 'in' => 'formData', 'schema' => ['description' => 'Video URL (choose either FileKey or URL)', 'type' => 'string', 'example' => 'https://example.com/video.mp4', 'title' => '', 'required' => false], ], [ 'name' => 'SnapshotInterval', 'in' => 'formData', 'schema' => ['description' => 'Snapshot interval', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'title' => '', 'required' => false], ], [ 'name' => 'Ext', 'in' => 'formData', 'schema' => ['description' => 'Extension parameters', 'type' => 'string', 'example' => '{}', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['description' => 'Request ID', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Code' => ['description' => 'Business status code', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Message' => ['description' => 'Return message', 'type' => 'string', 'example' => '任务提交成功', 'title' => ''], 'Success' => ['description' => 'Is successful', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'Submitted task result data', 'type' => 'object', 'properties' => [ 'TaskId' => ['description' => 'Task ID', 'type' => 'string', 'example' => 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'description' => 'Submit task response', 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'SubmitVideoAudit', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitVideoAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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 \\"TaskId\\": \\"xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\\"\\n }\\n}","type":"json"}]', 'translator' => 'machine', ], 'UpdateCustomText' => [ 'summary' => 'Updates custom text.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Workspace unique identifier: AgentKey', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Primary key ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '96'], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Title', 'type' => 'string', 'example' => '标题', 'required' => false], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Content', 'type' => 'string', 'example' => '内容', 'required' => false], ], [ 'name' => 'CommodityCode', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Commodity code', 'type' => 'string', 'example' => '商品code', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'PlainResult', 'title' => '', 'type' => 'object', 'properties' => [ 'Code' => ['title' => '', 'description' => 'Status code', 'type' => 'string', 'example' => 'NoData'], 'Data' => ['title' => '', 'description' => 'Business data', 'type' => 'integer', 'format' => 'int64', 'example' => '48'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'Message' => ['title' => '', 'description' => 'Fault description', 'type' => 'string', 'example' => 'success'], 'RequestId' => ['title' => '', 'description' => 'Request unique identifier', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Is successful: true for success, false for failure', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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"}]', 'title' => 'Update custom text', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'UpdateDataset' => [ 'summary' => 'This operation updates a data source.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get a workspaceId]().', 'type' => 'string', 'required' => true, 'example' => 'xxxx'], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetDescription', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'The description of the dataset.', 'type' => 'string', 'example' => '企业自定义数据集', 'maxLength' => 30, 'minLength' => 0, 'required' => false], ], [ 'name' => 'SearchDatasetEnable', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Specifies whether to enable search for the dataset.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'required' => false], ], [ 'name' => 'DatasetConfig', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The configurations for a third-party search dataset.', 'title' => '', 'type' => 'object', 'properties' => [ 'SearchSourceConfigs' => [ 'description' => 'Third-party search: API definition.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'DemoQuery' => ['title' => '', 'description' => 'A searchable keyword used to verify availability.', 'type' => 'string', 'example' => '可以搜索到的关键词，用来验证是否可用', 'required' => false], 'Size' => ['title' => '', 'description' => 'The default number of data entries for requests and responses.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], 'SearchSourceRequestConfig' => [ 'description' => 'The API request configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'Url' => ['title' => '', 'description' => 'The API URL.', 'type' => 'string', 'example' => 'api地址', 'required' => false], 'Method' => ['title' => '', 'description' => 'The request method.', 'type' => 'string', 'example' => '请求方式', 'required' => false], 'ConnectTimeout' => ['title' => '', 'description' => 'The connection timeout period, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'required' => false], 'SocketTimeout' => ['title' => '', 'description' => 'The read timeout period, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3000', 'required' => false], 'Headers' => [ 'description' => 'The HTTP request headers.', 'type' => 'array', 'items' => [ 'description' => 'The HTTP request headers.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => '参数名称', 'required' => false], 'ValueType' => ['title' => '', 'description' => 'The data type of the parameter value. Default: string.', 'type' => 'string', 'example' => '参数值数据类型：默认string', 'required' => false], 'ValueFormat' => ['title' => '', 'description' => 'This parameter is valid only when ValueType is set to time.', 'type' => 'string', 'example' => 'valueType = time 时有效', 'required' => false], 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => '参数值', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], 'Params' => [ 'description' => 'The request path parameters.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The request path parameters.', 'type' => 'object', 'properties' => [ 'Name' => ['title' => '', 'description' => 'The parameter name.', 'type' => 'string', 'example' => '参数名称', 'required' => false], 'ValueType' => ['title' => '', 'description' => 'The data type of the parameter value. Default: string.', 'type' => 'string', 'example' => '参数值数据类型：默认string', 'required' => false], 'ValueFormat' => ['title' => '', 'description' => 'This parameter is valid only when ValueType is set to time.', 'type' => 'string', 'example' => 'valueType = time 时有效', 'required' => false], 'Value' => ['title' => '', 'description' => 'The parameter value.', 'type' => 'string', 'example' => '参数值', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'PathParamsEnable' => ['title' => '', 'description' => 'Specifies whether to enable path parameters.', 'type' => 'boolean', 'example' => 'true', 'required' => false], 'Body' => ['title' => '', 'description' => 'The request body.', 'type' => 'string', 'example' => '{}', 'required' => false], ], 'required' => false, 'example' => '', ], 'SearchSourceResponseConfig' => [ 'description' => 'The API response configuration.', 'title' => '', 'type' => 'object', 'properties' => [ 'JqNodes' => [ 'description' => 'The node configuration.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'Key' => ['title' => '', 'description' => 'The node key.', 'type' => 'string', 'example' => '节点key', 'required' => false], 'Type' => ['title' => '', 'description' => 'The data type of the node. Valid values: string, number, list, object, and base.', 'type' => 'string', 'example' => '节点数据类型：string number list object base', 'required' => false], 'Path' => ['title' => '', 'description' => 'The node path.', 'type' => 'string', 'example' => '节点路径', 'required' => false], 'JqNodes' => [ 'description' => 'The child node configuration.', 'title' => '', 'type' => 'array', 'items' => [ 'description' => 'The child node configuration.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The node key.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], 'Type' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], 'Path' => ['description' => 'The node path.', 'type' => 'string', 'required' => false, 'example' => '.title', 'title' => ''], 'JqNodes' => [ 'description' => 'The child node configuration.', 'type' => 'array', 'items' => [ 'description' => 'The child node configuration.', 'type' => 'object', 'properties' => [ 'Key' => ['description' => 'The node key.', 'type' => 'string', 'required' => false, 'example' => 'title', 'title' => ''], 'Type' => ['description' => 'The type.', 'type' => 'string', 'required' => false, 'example' => 'string', 'title' => ''], 'Path' => ['description' => 'The node path.', 'type' => 'string', 'required' => false, 'example' => '.title', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], ], 'required' => false, 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'SearchSourceConfig' => [ 'description' => 'The dataset configuration items.', 'type' => 'object', 'properties' => [ 'TagSearchEnable' => ['description' => 'Specifies whether tags are included in searches. Default: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'TagGenerateEnable' => ['description' => 'Specifies whether tags are used for generation. Default: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'MetadataKeyValueSearchEnable' => ['description' => 'Specifies whether the key-value pairs in metadata are included in searches. Default: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], 'MetadataKeyValueGenerateEnable' => ['description' => 'Specifies whether the key-value pairs in metadata are used for generation. Default: true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'example' => '', ], ], [ 'name' => 'AccessLevel', 'in' => 'formData', 'schema' => ['type' => 'string', 'example' => 'private', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'The response.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'DatasetId' => ['title' => '', 'description' => 'The dataset ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'CreateUser' => ['title' => '', 'description' => 'The creator.', 'type' => 'string', 'example' => 'xxx'], 'CreateTime' => ['title' => '', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-11-12 21:46:24'], 'DatasetType' => ['title' => '', 'description' => 'The dataset type.', 'type' => 'string', 'example' => 'CustomSemanticSearch'], 'DatasetName' => ['title' => '', 'description' => 'The dataset name.', 'type' => 'string', 'example' => 'xxx'], 'DatasetDescription' => ['title' => '', 'description' => 'The display name of the dataset.', 'type' => 'string', 'example' => 'xxx'], 'SearchDatasetEnable' => ['title' => '', 'description' => 'Indicates whether search is enabled for the dataset.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'NewsArticleResults' => [ 'description' => 'The list of articles.', 'type' => 'array', 'items' => [ 'description' => 'The list of articles.', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'The list of articles.', 'type' => 'array', 'items' => [ 'description' => 'The article.', 'type' => 'object', 'properties' => [ 'PubTime' => ['title' => '', 'description' => 'The publishing time.', 'type' => 'string', 'example' => '2024-11-12 15:12:14'], 'Source' => ['title' => '', 'description' => 'The source.', 'type' => 'string', 'example' => '央视网'], 'Title' => ['title' => '', 'description' => 'The title.', 'type' => 'string', 'example' => '文章标题'], 'Content' => ['title' => '', 'description' => 'The content.', 'type' => 'string', 'example' => '文章内容'], 'Url' => ['title' => '', 'description' => 'The article URL.', 'type' => 'string', 'example' => 'https://www.example.com/aaa.docx'], 'Summary' => ['title' => '', 'description' => 'The article summary.', 'type' => 'string', 'example' => '文章摘要'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'Current' => ['title' => '', 'description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'Size' => ['title' => '', 'description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'Total' => ['title' => '', 'description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'The status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Data source – Modification ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', '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 \\"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"}]', 'translator' => 'machine', ], 'UpdateDatasetDocument' => [ 'summary' => 'Updates a document in a dataset.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of the Alibaba Cloud Model Studio workspace. For more information, see [Get the workspace ID](~~2782167~~).', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'Document', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'The document to update.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'Unique ID of the document in the system.', 'type' => 'string', 'example' => 'xxx', 'required' => false], 'Title' => ['description' => 'Document title.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'DocId' => ['title' => '', 'description' => 'User-defined unique ID for the document.', 'type' => 'string', 'example' => 'xxx', 'required' => false], 'CategoryUuid' => ['description' => 'UUID of the category', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'Tags' => [ 'description' => 'Tags', 'type' => 'array', 'items' => ['description' => 'Tag value.', 'type' => 'string', 'required' => false, 'example' => 'xx', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'Extend1' => ['description' => 'Extension field 1', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3', 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], ], 'required' => true, 'example' => '', ], ], [ 'name' => 'DatasetId', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Unique identifier of the dataset.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'DatasetName', 'in' => 'formData', 'schema' => ['title' => '', 'description' => 'Name of the dataset.', 'type' => 'string', 'example' => '数据集名称', 'required' => false], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'description' => 'Response body.', 'title' => '', 'type' => 'object', 'properties' => [ 'Data' => [ 'description' => 'Business data.', 'title' => '', 'type' => 'object', 'properties' => [ 'DocUuid' => ['title' => '', 'description' => 'Internal unique ID of the document.', 'type' => 'string', 'example' => '内部文档唯一ID'], 'Title' => ['description' => 'Document title.', 'type' => 'string', 'example' => '文章标题', 'title' => ''], 'DocId' => ['title' => '', 'description' => 'User-defined unique ID for the document.', 'type' => 'string', 'example' => '用户指定的文档唯一ID'], 'Tags' => [ 'description' => 'Tags.', 'type' => 'array', 'items' => ['description' => 'Tag.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'title' => '', 'example' => '', ], 'CategoryUuid' => ['description' => 'Category UUID ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend1' => ['description' => 'Extension field 1 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend2' => ['description' => 'Extension field 2 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'Extend3' => ['description' => 'Extension field 3 ', 'type' => 'string', 'example' => 'xx', 'title' => ''], ], 'example' => '', ], 'RequestId' => ['title' => '', 'description' => 'Unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['title' => '', 'description' => 'Indicates whether the operation succeeded. A value of true indicates success. A value of false indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'Code' => ['title' => '', 'description' => 'Status code.', 'type' => 'string', 'example' => 'NoData'], 'Message' => ['title' => '', 'description' => 'Error message.', 'type' => 'string', 'example' => 'success'], 'HttpStatusCode' => ['title' => '', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Data Source – Modify Document', 'changeSet' => [ ['createdAt' => '2024-12-18T04:52:17.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UpdateGeneralConfig' => [ 'summary' => 'Updates general configurations.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the Model Studio workspace. For more information, see [Get a workspaceId](~~2782167~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'xxxx'], ], [ 'name' => 'ConfigKey', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the configuration item. The following configurations are supported:'."\n" ."\n" .'- Text search threshold for data sources (double): \\`searchGenerate.searchTextMinScore\\`'."\n" ."\n" .'- Image search threshold for data sources (double): \\`searchGenerate.searchImageMinScore\\`'."\n" ."\n" .'- Video search threshold for data sources (double): \\`searchGenerate.searchVideoMinScore\\`'."\n" ."\n" .'- Audio search threshold for data sources (double): \\`searchGenerate.searchAudioMinScore\\`'."\n" ."\n" .'- Plain text prompt template for answer summarization in general Q\\&A search (string): \\`searchGenerate.sumQaAgentPrompt\\`'."\n" ."\n" .'- Text and image prompt template for answer summarization in general Q\\&A search (string): \\`searchGenerate.sumQaAgentVlPrompt\\`'."\n" ."\n" .'- Plain text prompt template for answer summarization in enhanced Q\\&A search (string): \\`searchGenerate.sumQaEnhanceAgentPrompt\\`'."\n" ."\n" .'- Text and image prompt template for answer summarization in enhanced Q\\&A search (string): \\`searchGenerate.sumQaEnhanceAgentVlPrompt\\`', 'type' => 'string', 'required' => true, 'example' => 'xx', 'title' => ''], ], [ 'name' => 'ConfigValue', 'in' => 'formData', 'schema' => ['description' => 'The value of the configuration item.', 'type' => 'string', 'required' => true, 'example' => 'xxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'Data' => [ 'title' => '', 'description' => 'The unique identifier of the configuration item.', 'type' => 'object', 'properties' => [ 'ConfigKey' => ['description' => 'The unique identifier of the configuration.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'ConfigValue' => ['description' => 'The value of the configuration.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], 'ConfigValueType' => ['description' => 'The data type of the configuration value.', 'type' => 'string', 'example' => 'xx', 'title' => ''], 'ConfigDesc' => ['description' => 'The description of the configuration item.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], ], 'example' => '', ], 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. \\`true\\` indicates success. \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'example' => '', ], ], ], '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' => 'General Configuration - Modify', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UpdateGeneratedContent' => [ 'summary' => 'Updates the history of an article created in AiMiaoBi.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'The unique identifier of the workspace. For more information, see [AgentKey](~~2587494~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxxx_p_efm', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'The unique identifier of the document.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '36', 'title' => ''], ], [ 'name' => 'Prompt', 'in' => 'formData', 'schema' => ['description' => 'The last prompt that was used to generate the content.', 'type' => 'string', 'example' => '创作xx文章', 'title' => '', 'required' => false], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'The title.', 'type' => 'string', 'example' => '文章名称', 'maxLength' => 200, 'minLength' => 2, 'title' => '', 'required' => false], ], [ 'name' => 'Content', 'in' => 'formData', 'schema' => ['description' => 'The body of the article in rich text format.', 'type' => 'string', 'example' => '正文', 'title' => '', 'required' => false], ], [ 'name' => 'ContentText', 'in' => 'formData', 'schema' => ['description' => 'The body of the article in plain text format.', 'type' => 'string', 'example' => '正文', 'title' => '', 'required' => false], ], [ 'name' => 'Keywords', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'The keywords.', 'type' => 'array', 'items' => ['description' => 'A keyword.', 'type' => 'string', 'required' => false, 'example' => '登机', 'title' => ''], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'The status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Data' => ['description' => 'The returned data.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Indicates whether the request was successful. A value of \\`true\\` indicates success. A value of \\`false\\` indicates failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Update Document', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateGeneratedContent'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'UpdateMaterialDocument' => [ 'summary' => 'Update a material in the Material Library.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'AgentKey', 'in' => 'query', 'schema' => ['description' => 'Unique identifier of the workspace: [AgentKey](~~2587494~~)', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '67c520d1fa43455ea44fb69fa402d54d_p_beebot_public'], ], [ 'name' => 'Id', 'in' => 'formData', 'schema' => ['description' => 'Primary key', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '44', 'title' => ''], ], [ 'name' => 'DocType', 'in' => 'formData', 'schema' => [ 'description' => 'Document type. Valid values: html, plainText, image, pdf, word, excel, csv, jsonLine', 'type' => 'string', 'required' => true, 'example' => 'image', 'enum' => ['html', 'plainText', 'image', 'pdf', 'word', 'excel', 'csv', 'jsonLine'], 'title' => '', ], ], [ 'name' => 'Title', 'in' => 'formData', 'schema' => ['description' => 'Document title', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '标题'], ], [ 'name' => 'Author', 'in' => 'formData', 'schema' => ['description' => 'Author', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '作者名称'], ], [ 'name' => 'PubTime', 'in' => 'formData', 'schema' => ['description' => 'Publication time in yyyy-MM-dd HH:mm:ss format', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '2023-04-11 06:14:07'], ], [ 'name' => 'DocKeywords', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'title' => '', 'description' => 'Document tags for categorization', 'type' => 'array', 'items' => ['description' => 'Keyword', 'type' => 'string', 'required' => false, 'example' => '关键词', 'title' => ''], 'required' => false, 'example' => '', ], ], [ 'name' => 'Url', 'in' => 'formData', 'schema' => ['description' => 'URL of the material', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://xxxxx/xxx'], ], [ 'name' => 'ExternalUrl', 'in' => 'formData', 'schema' => ['description' => 'URL uploaded by an external customer. Used only for record keeping', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'http://xxxxx/xxx'], ], [ 'name' => 'SrcFrom', 'in' => 'formData', 'schema' => [ 'description' => 'Source of the document. Valid values: UserUpload, IntellijSearch, HotViewPoint', 'type' => 'string', 'example' => 'UserUpload', 'enum' => ['UserUpload', 'IntellijSearch', 'HotViewPoint'], 'title' => '', 'required' => false, ], ], [ 'name' => 'TextContent', 'in' => 'formData', 'schema' => ['description' => 'Parsed text content. Empty for images', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '文本内容'], ], [ 'name' => 'HtmlContent', 'in' => 'formData', 'schema' => ['description' => 'Formatted content', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '网页内容'], ], [ 'name' => 'ShareAttr', 'in' => 'formData', 'schema' => [ 'description' => 'Sharing attribute. Valid values: 0 (private), 1 (shared within the workspace)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'enum' => ['0', '1'], 'title' => '', 'required' => false, ], ], [ 'name' => 'Summary', 'in' => 'formData', 'schema' => ['description' => 'Summary', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '摘要'], ], [ 'name' => 'RegionId', 'in' => 'query', 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'PlainResult\\', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'DataNotExists', 'title' => ''], 'Data' => ['description' => 'Business data', 'type' => 'integer', 'format' => 'int64', 'example' => '82', 'title' => ''], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => '数据不存在', 'title' => ''], 'RequestId' => ['description' => 'Unique request identifier', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21', 'title' => ''], 'Success' => ['description' => 'Indicates success. true means successful. false means failed', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"DataNotExists\\",\\n \\"Data\\": 82,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"数据不存在\\",\\n \\"RequestId\\": \\"3f7045e099474ba28ceca1b4eb6d6e21\\",\\n \\"Success\\": false\\n}","type":"json"}]', 'title' => 'Update Material', 'changeSet' => [ ['createdAt' => '2024-07-19T02:29:44.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [ ['threshold' => '600', 'countWindow' => 60, 'regionId' => '*', 'api' => 'UpdateMaterialDocument'], ], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateMaterialDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], 'additionalActions' => [], ], ], 'translator' => 'machine', ], 'UploadBook' => [ 'summary' => 'Use MiaoDu to upload books.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace. [Get your workspace ID](~~2782167~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-ipe7d81yq4sl5jmk', 'title' => ''], ], [ 'name' => 'Docs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Documents', 'type' => 'array', 'items' => [ 'description' => 'Document', 'type' => 'object', 'properties' => [ 'DocName' => ['description' => 'Document name', 'type' => 'string', 'required' => false, 'example' => '文档1.pdf', 'title' => ''], 'FileUrl' => ['description' => 'File URL', 'type' => 'string', 'required' => false, 'example' => 'http://xxx/ccc.pdf', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'Folder ID', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'RequestId' => ['title' => '', 'description' => 'Request ID', 'type' => 'string', 'example' => '3f7045e099474ba28ceca1b4eb6d6e21'], 'Code' => ['description' => 'Status code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'Business data', 'type' => 'object', 'properties' => [ 'DocIds' => [ 'description' => 'Document IDs', 'type' => 'array', 'items' => ['description' => 'Document ID', 'type' => 'string', 'example' => 'aaaxxx', 'title' => ''], 'title' => '', 'example' => '', ], 'ExistedIds' => [ 'description' => 'IDs of duplicate documents', 'type' => 'array', 'items' => ['description' => 'Document ID', 'type' => 'string', 'example' => 'ccccc', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Success' => ['description' => 'Operation result. Set to true for success. Set to false for failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], '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' => 'Book Upload', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:UploadBook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], 'UploadDoc' => [ 'summary' => 'Upload document API for Miaodu.', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier (UUID) of the Alibaba Cloud Model Studio workspace: obtain the [Workspace ID](~~2587495~~)', 'type' => 'string', 'required' => true, 'example' => 'llm-yigtrrjl377rcbab', 'title' => ''], ], [ 'name' => 'Docs', 'in' => 'formData', 'style' => 'json', 'schema' => [ 'description' => 'Document', 'type' => 'array', 'items' => [ 'description' => 'document', 'type' => 'object', 'properties' => [ 'DocName' => ['description' => 'document Name', 'type' => 'string', 'required' => true, 'example' => '文档1.pdf', 'title' => ''], 'FileUrl' => ['description' => 'file URL', 'type' => 'string', 'required' => true, 'example' => 'http://xxx/ccc.pdf', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], 'required' => true, 'title' => '', 'example' => '', ], ], [ 'name' => 'CategoryId', 'in' => 'formData', 'schema' => ['description' => 'Folder where the document resides. If no value is provided, it defaults to "default".', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Internal error code', 'type' => 'string', 'example' => 'successful', 'title' => ''], 'Data' => [ 'description' => 'Document information', 'type' => 'object', 'properties' => [ 'DocIds' => [ 'description' => 'Array of successfully uploaded document IDs', 'type' => 'array', 'items' => ['description' => 'Document ID', 'type' => 'string', 'example' => 'aaaxxx', 'title' => ''], 'title' => '', 'example' => '', ], 'ExistedIds' => [ 'description' => 'Document IDs that could not be uploaded because they already exist', 'type' => 'array', 'items' => ['description' => 'Document ID', 'type' => 'string', 'example' => 'ccccc', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error description', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5'], 'Success' => ['description' => 'Indicates whether the operation succeeded', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'NoPermission', 'errorMessage' => 'You are not authorized to perform this action.', 'description' => 'Please check the workspaceId assignment'], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Document Upload', 'description' => 'Document upload is implemented through asynchronous invocation. After the invocation, you must use the getDocInfo API to periodically check the document status. Only when the document status becomes 1 can you proceed with subsequent operations such as generating a document summary, creating a full-text mind map, summarizing Q&A content, extracting keywords, or rewriting.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:UploadDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'gatewayOptions' => [ 'gatewayProtocols' => [], ], 'translator' => 'machine', ], 'ValidateUploadTemplate' => [ 'summary' => 'Validates an enterprise VOC upload template.', 'path' => '', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'WorkspaceId', 'in' => 'formData', 'schema' => ['description' => 'Unique identifier of your Alibaba Cloud Model Studio workspace. To get this ID, see [Workspace ID](~~2782167~~).', 'type' => 'string', 'required' => true, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'TemplateType', 'in' => 'formData', 'schema' => ['description' => 'Template type. Valid values: Content (content asset template) or PositiveSample (positive sample template).', 'type' => 'string', 'required' => true, 'example' => 'Content', 'title' => ''], ], [ 'name' => 'FileKey', 'in' => 'formData', 'schema' => ['description' => 'File key.', 'type' => 'string', 'required' => true, 'example' => 'Content', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'formData', 'schema' => ['description' => 'Task type. Valid values: lightAppSass (SaaS page call) or sdkBatchTask (SDK batch task).', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'lightAppSass'], ], ], 'responses' => [ 200 => [ 'description' => '成功', 'schema' => [ 'title' => '', 'description' => 'PlainResult', 'type' => 'object', 'properties' => [ 'Code' => ['description' => 'Status code.', 'type' => 'string', 'example' => 'NoData', 'title' => ''], 'Data' => [ 'title' => '', 'description' => 'Template validation result.', 'type' => 'object', 'properties' => [ 'TotalCount' => ['description' => 'Total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'CommentCount' => ['description' => 'Number of comments.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], 'DialogueCount' => ['description' => 'Number of dialogues.', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'title' => ''], ], 'example' => '', ], 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Message' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'RequestId' => ['description' => 'Unique request identifier.', 'type' => 'string', 'example' => '1813ceee-7fe5-41b4-87e5-982a4d18cca5', 'title' => ''], 'Success' => ['description' => 'Operation status. Returns true on success. Returns false on failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], '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' => 'Validate VOC upload template', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ValidateUploadTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'translator' => 'machine', ], ], 'endpoints' => [ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', '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' => 'No permission to access current interface or resource'], ['code' => 'Forbidden', 'message' => 'no permission to access action.', 'http_code' => 403, 'description' => 'The current account does not have permission to operate the corresponding business space of the workspaceId. Please use the account with permission to go to the Bailian console to authorize the current account.'], ['code' => 'NoPermission', 'message' => 'You are not authorized to perform this action.', 'http_code' => 403, 'description' => 'Please check the workspaceId assignment'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'RunSearchGeneration'], ], 'createdAt' => '2025-11-12T02:51:11.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'AddAuditTerms'], ['description' => 'Request parameters changed', 'api' => 'DeleteAuditNote'], ['description' => 'Request parameters changed', 'api' => 'DownloadAuditNote'], ['description' => 'Request parameters changed', 'api' => 'GetAvailableAuditNotes'], ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAuditTerms'], ['description' => 'Request parameters changed', 'api' => 'SubmitAuditNote'], ['description' => 'Request parameters changed', 'api' => 'SubmitExportTermsTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitImportTermsTask'], ['description' => 'Request parameters changed', 'api' => 'SubmitSmartAudit'], ], 'createdAt' => '2025-11-11T11:58:58.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'SearchNews'], ], 'createdAt' => '2024-05-29T08:39:52.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'GenerateFileUrlByKey'], ['description' => 'Request parameters changed', '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' => 'Alibaba Cloud Model Studio', 'ramCodes' => ['aimiaobi'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'RunDocTranslation', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocTranslation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunWriting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAuditNote', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InitiatePptCreationV2', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:InitiatePptCreationV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitImportTermsTask', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:SubmitImportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTopicViewPointRecommendEventList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListTopicViewPointRecommendEventList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchDatasetDocuments', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:SearchDatasetDocuments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunGenerateQuestions', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunGenerateQuestions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAutoClipsTaskInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAutoClipsTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunStyleFeatureAnalysis', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunStyleFeatureAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GenerateExportWordTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GenerateExportWordTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunCustomHotTopicViewPointAnalysis', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunCustomHotTopicViewPointAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteGeneratedContent', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:DeleteGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AsyncUploadVideo', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncUploadVideo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AsyncCreateClipsTimeLine', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncCreateClipsTimeLine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCustomSourceTopicAnalysisTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomSourceTopicAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListMaterialDocuments', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListMaterialDocuments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitCustomSourceTopicAnalysis', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitCustomSourceTopicAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInterveneGlobalReply', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneGlobalReply', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddAuditTerms', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AddAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDocs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDocs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPptConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAuditContentErrorTypes', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAuditContentErrorTypes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasetDocuments', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDatasetDocuments', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteInterveneRule', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:DeleteInterveneRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListBiddingDoc', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetSmartAuditResult', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetSmartAuditResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDataset', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GenerateViewPoint', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GenerateViewPoint', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunSearchSimilarArticles', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:RunSearchSimilarArticles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDatasetDocument', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InsertInterveneRule', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:InsertInterveneRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AsyncUploadTenderDoc', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncUploadTenderDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunCommentGeneration', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunCommentGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateGeneratedContent', 'description' => '', 'operationType' => 'update', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:UpdateGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ClearIntervenes', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ClearIntervenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DownloadAuditNote', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:DownloadAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDataPermissions', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDataPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListHotTopics', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListHotTopics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDocSmartCard', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocSmartCard', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDocSummary', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocSummary', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDataSourceOrderConfig', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetDataSourceOrderConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelDeepWriteTask', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:CancelDeepWriteTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInterveneRules', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListInterveneRules', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SaveOrUpdateOssConfig', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:SaveOrUpdateOssConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitCustomTopicSelectionPerspectiveAnalysisTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitCustomTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListWebReviewPoints', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListWebReviewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDocIntroduction', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocIntroduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DocumentExtraction', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:DocumentExtraction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteAuditTerms', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FeedbackDialogue', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:FeedbackDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateMaterialDocument', 'description' => '', 'operationType' => 'update', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:UpdateMaterialDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCustomTopicByTopic', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteCustomTopicByTopic', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDocWashing', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocWashing', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetClipsBuildInResource', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetClipsBuildInResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeletePptArtifact', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeletePptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCategoriesByTaskId', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCategoriesByTaskId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateGeneralConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SaveMaterialDocument', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:SaveMaterialDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AsyncEditTimeline', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:AsyncEditTimeline', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomText', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListFreshViewPoints', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListFreshViewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListWritingStyles', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListWritingStyles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitCustomHotTopicBroadcastJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitCustomHotTopicBroadcastJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitTopicSelectionPerspectiveAnalysisTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDataset', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDeepWriteTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDeepWriteTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetEnterpriseVocAnalysisTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetEnterpriseVocAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateToken', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:CreateToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportAnalysisTagDetailByTaskId', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportAnalysisTagDetailByTaskId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDeepWriting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunDeepWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListSearchTasks', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListSearchTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListStyleLearningResult', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInterveneImportTaskInfo', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneImportTaskInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunHotword', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunHotword', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListGeneratedContents', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListGeneratedContents', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelAsyncTask', 'description' => '', 'operationType' => 'update', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:CancelAsyncTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryAsyncTask', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:QueryAsyncTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ImportInterveneFileAsync', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ImportInterveneFileAsync', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetSmartClipTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetSmartClipTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportHotTopicPlanningProposals', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportHotTopicPlanningProposals', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunPptOutlineGeneration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunPptOutlineGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListHotViewPoints', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListHotViewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateCustomText', 'description' => '', 'operationType' => 'update', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:UpdateCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GenerateImageTask', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GenerateImageTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryAuditTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:QueryAuditTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCustomText', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunKeywordsExtractionGeneration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunKeywordsExtractionGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateGeneratedContent', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:CreateGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ImportInterveneFile', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ImportInterveneFile', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDialogues', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListDialogues', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetGeneratedContent', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListHotNewsWithType', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListHotNewsWithType', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitEnterpriseVocAnalysisTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:SubmitEnterpriseVocAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunBookBrainmap', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunBookBrainmap', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDocs', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDocs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetTopicById', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetTopicById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunTranslateGeneration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTranslateGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunQuickWriting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunQuickWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InsertInterveneGlobalReply', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:InsertInterveneGlobalReply', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteCustomTopicViewPointById', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteCustomTopicViewPointById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunTopicSelectionMerge', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTopicSelectionMerge', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListSearchTaskDialogues', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListSearchTaskDialogues', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AddDatasetDocument', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AddDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDatasetDocument', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetHotTopicBroadcast', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetHotTopicBroadcast', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitVideoAudit', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitVideoAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAuditTerms', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunAiHelperWriting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunAiHelperWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SaveStyleLearningResult', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SaveStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SaveDataSourceOrderConfig', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:SaveDataSourceOrderConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListCustomViewPoints', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListCustomViewPoints', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunTextPolishing', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTextPolishing', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetProperties', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetProperties', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetTopicSelectionPerspectiveAnalysisTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListEnterprisePptTemplates', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListEnterprisePptTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FetchExportWordTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:FetchExportWordTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAutoClipsTask', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListAutoClipsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListPptArtifacts', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListPptArtifacts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadBook', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:UploadBook', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTopicRecommendEventList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListTopicRecommendEventList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDataset', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListIntervenes', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListIntervenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GenerateFileUrlByKey', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GenerateFileUrlByKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EditAuditTerms', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:EditAuditTerms', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCustomHotTopicBroadcastJob', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomHotTopicBroadcastJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FetchImageTask', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:FetchImageTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPptArtifact', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetPptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunWriteToneGeneration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunWriteToneGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryVideoAuditResult', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:QueryVideoAuditResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPptInfo', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunAbbreviationContent', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunAbbreviationContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteMaterialById', 'description' => '', 'operationType' => 'delete', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:DeleteMaterialById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateDataPermissions', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:CreateDataPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitSmartClipTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitSmartClipTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListPlanningProposal', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListPlanningProposal', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunStepByStepWriting', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunStepByStepWriting', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInterveneRuleDetail', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneRuleDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCustomText', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunSummaryGenerate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunSummaryGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UploadDoc', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:UploadDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunCustomHotTopicAnalysis', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunCustomHotTopicAnalysis', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateGeneralConfig', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunBookIntroduction', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunBookIntroduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AsyncCreateClipsTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncCreateClipsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitSmartAudit', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitSmartAudit', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'BindPptArtifact', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:BindPptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportIntervenes', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ExportIntervenes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SaveCustomText', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:SaveCustomText', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListVersions', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListVersions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPptArtifactExportResult', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptArtifactExportResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListSearchTaskDialogueDatas', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListSearchTaskDialogueDatas', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ValidateUploadTemplate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ValidateUploadTemplate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListInterveneCnt', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListInterveneCnt', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFactAuditUrl', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:GetFactAuditUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunWritingV2', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunWritingV2', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDatasets', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDatasets', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunSearchGeneration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunSearchGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitDeepWriteTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitDeepWriteTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAuditNote', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:SubmitAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetBiddingRemainLimitNum', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetBiddingRemainLimitNum', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportCustomSourceAnalysisTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ExportCustomSourceAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDocClusterTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDocClusterTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunVideoScriptGenerate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunVideoScriptGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListHotSources', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListHotSources', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAnalysisTagDetailByTaskId', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:ListAnalysisTagDetailByTaskId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListDocumentRetrieve', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListDocumentRetrieve', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListBuildConfigs', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListBuildConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetCustomTopicSelectionPerspectiveAnalysisTask', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetCustomTopicSelectionPerspectiveAnalysisTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitExportTermsTask', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:SubmitExportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DownloadBiddingDoc', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:DownloadBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunBookSmartCard', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunBookSmartCard', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListPptTemplates', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListPptTemplates', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteStyleLearningResult', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AsyncWritingBiddingDoc', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:AsyncWritingBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'InitiatePptCreation', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:InitiatePptCreation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAvailableAuditNotes', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAvailableAuditNotes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDeepWriteTaskResult', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDeepWriteTaskResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportPptArtifact', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:ExportPptArtifact', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetGeneralConfig', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDataset', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateDataset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetInterveneTemplateFileUrl', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetInterveneTemplateFileUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetStyleLearningResult', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetStyleLearningResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTimedViewAttitude', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListTimedViewAttitude', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FetchExportTermsTask', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:FetchExportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAuditNoteProcessingStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAuditNoteProcessingStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteDataPermissions', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteDataPermissions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunContinueContent', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunContinueContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'FetchImportTermsTask', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:FetchImportTermsTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAuditNotePostProcessingStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetAuditNotePostProcessingStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetBiddingDocInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetBiddingDocInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDocBrainmap', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocBrainmap', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListGeneralConfigs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aimiaobi:ListGeneralConfigs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateDatasetDocument', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:UpdateDatasetDocument', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetDocInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetDocInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAsyncTask', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:SubmitAsyncTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunMultiDocIntroduction', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunMultiDocIntroduction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListAsyncTasks', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ListAsyncTasks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunTitleGeneration', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:RunTitleGeneration', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GenerateUploadConfig', 'description' => '', 'operationType' => 'create', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GenerateUploadConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetMaterialById', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:GetMaterialById', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ConfirmAndPostProcessAuditNote', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aimiaobi:ConfirmAndPostProcessAuditNote', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitDocClusterTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitDocClusterTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetPptTemplateSelector', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:GetPptTemplateSelector', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunExpandContent', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunExpandContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetFileContentLength', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:GetFileContentLength', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CancelAuditTask', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:CancelAuditTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportGeneratedContent', 'description' => '', 'operationType' => 'get', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:ExportGeneratedContent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'RunDocQa', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aimiaobi:RunDocQa', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'EditBiddingDoc', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aimiaobi:EditBiddingDoc', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitAuditTask', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitAuditTask', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteGeneralConfig', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteGeneralConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SearchNews', 'description' => '', 'operationType' => 'list', 'additionalActions' => [], 'ramAction' => [ 'action' => 'aimiaobi:SearchNews', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'DeleteFactAuditUrl', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aimiaobi:DeleteFactAuditUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExportAuditContentResult', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:ExportAuditContentResult', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'SubmitFactAuditUrl', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aimiaobi:SubmitFactAuditUrl', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiMiaoBi', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];