summaryrefslogtreecommitdiff
path: root/data/zh_cn/aicontent
diff options
context:
space:
mode:
authorZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
committerZhineng Li <im@zhineng.li>2026-07-12 17:11:17 +0800
commit1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 (patch)
tree5f0857666365b7e40cdaa3733ebe1f3ba9e13c67 /data/zh_cn/aicontent
parent7347bac4ab7e136157fc94777e6cf87ef9e08599 (diff)
downloadafterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.tar.gz
afterglow-metadata-full-1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634.zip
update APIs 20260712
Diffstat (limited to 'data/zh_cn/aicontent')
-rw-r--r--data/zh_cn/aicontent/20240611/api-docs.php18149
1 files changed, 10233 insertions, 7916 deletions
diff --git a/data/zh_cn/aicontent/20240611/api-docs.php b/data/zh_cn/aicontent/20240611/api-docs.php
index 48b1186..3c9a54d 100644
--- a/data/zh_cn/aicontent/20240611/api-docs.php
+++ b/data/zh_cn/aicontent/20240611/api-docs.php
@@ -1,103 +1,46 @@
<?php return [
'version' => '1.0',
- 'info' => [
- 'style' => 'ROA',
- 'product' => 'AiContent',
- 'version' => '20240611',
- ],
+ 'info' => ['style' => 'ROA', 'product' => 'AiContent', 'version' => '20240611'],
'directories' => [
[
- 'id' => 204286,
- 'title' => '口语评测',
- 'type' => 'directory',
'children' => [
- 'CreateAccessWarrant',
- 'QueryApplicationAccessId',
- 'QueryProjectList',
- 'QueryProject',
- 'CreateProject',
- 'UpdateProject',
- 'QueryPurchasedService',
+ 'ModelRouterCreateBalanceTransaction', 'ModelRouterGetClientBalanceLogs', 'ModelRouterGetClientBalance', 'ModelRouterConfigureClientBalance', 'ModelRouterQueryUsageBreakdown', 'ModelRouterQueryBillingCostBreakdown', 'ModelRouterUpdateBillingRule', 'ModelRouterQueryClientTree', 'ModelRouterQueryClientDiscountLogs', 'ModelRouterQueryBillingRuleList', 'ModelRouterCreateBillingRule', 'ModelRouterBillingCostTabs', 'ModelRouterQueryCostOverviewMetrics', 'ModelRouterQueryCostTrendMetrics', 'ModelRouterQueryCostModelList', 'ModelRouterQueryCostModelDetail', 'ModelRouterCreateModel', 'ModelRouterUpdateModel', 'ModelRouterUpdateConversation', 'ModelRouterUpdateClient',
+ 'ModelRouterQueryObservationMetrics', 'ModelRouterQueryObservationLogs', 'ModelRouterQueryObservationCharts', 'ModelRouterQueryNacosTags', 'ModelRouterQueryNacosProviders', 'ModelRouterQueryModelList', 'ModelRouterQueryModel', 'ModelRouterQueryConversationList', 'ModelRouterQueryConversation', 'ModelRouterQueryClientList', 'ModelRouterQueryApiKeyList', 'ModelRouterQueryApiKey', 'ModelRouterDeleteModel', 'ModelRouterDeleteClient', 'ModelRouterDeleteConversation', 'ModelRouterDeleteApiKey', 'ModelRouterCreateApiKey', 'ModelRouterCreateClient', 'ModelRouterCreateConversation', 'ModelRouterChatCompletions',
+ 'ModelRouterCopyApiKey',
],
+ 'type' => 'directory',
+ 'title' => 'Model Router',
+ 'id' => 451876,
],
[
- 'id' => 203174,
- 'title' => 'AI语文老师',
+ 'children' => ['CreateAccessWarrant', 'QueryApplicationAccessId', 'QueryProjectList', 'QueryProject', 'CreateProject', 'UpdateProject', 'QueryPurchasedService'],
'type' => 'directory',
- 'children' => [
- 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun',
- ],
+ 'title' => '口语评测',
+ 'id' => 451877,
],
[
- 'id' => 201597,
- 'title' => '英语教材式AI老师',
+ 'children' => ['ExecuteAITeacherChineseCompositionTutoringWorkflowRun'],
'type' => 'directory',
- 'children' => [
- 'GetTextbookAssistantToken',
- 'ListTextbookAssistantGradeVolumes',
- 'ListTextbookAssistantBooks',
- 'ListTextbookAssistantBookDirectories',
- 'ListTextbookAssistantArticles',
- 'ListTextbookAssistantArticleDetails',
- 'ListTextbookAssistantSceneDetails',
- 'ExecuteTextbookAssistantStartConversation',
- 'ExecuteTextbookAssistantDialogue',
- 'ExecuteTextbookAssistantSseDialogue',
- 'ExecuteTextbookAssistantTranslate',
- 'ExecuteTextbookAssistantSuggestion',
- 'ExecuteTextbookAssistantDifficulty',
- 'ExecuteTextbookAssistantRefineByContext',
- 'ExecuteTextbookAssistantGrammarCheck',
- 'ExecuteTextbookAssistantRetryConversation',
- ],
+ 'title' => 'AI语文老师',
+ 'id' => 451878,
],
[
- 'id' => 200015,
- 'title' => 'AI英语老师',
+ 'children' => ['GetTextbookAssistantToken', 'ListTextbookAssistantGradeVolumes', 'ListTextbookAssistantBooks', 'ListTextbookAssistantBookDirectories', 'ListTextbookAssistantArticles', 'ListTextbookAssistantArticleDetails', 'ListTextbookAssistantSceneDetails', 'ExecuteTextbookAssistantStartConversation', 'ExecuteTextbookAssistantDialogue', 'ExecuteTextbookAssistantSseDialogue', 'ExecuteTextbookAssistantTranslate', 'ExecuteTextbookAssistantSuggestion', 'ExecuteTextbookAssistantDifficulty', 'ExecuteTextbookAssistantRefineByContext', 'ExecuteTextbookAssistantGrammarCheck', 'ExecuteTextbookAssistantRetryConversation'],
'type' => 'directory',
- 'children' => [
- 'ExecuteAITeacherEnglishParaphraseChatMessage',
- 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun',
- 'AITeacherSyncPracticeTaskGenerate',
- 'ExecuteAITeacherSyncDialogue',
- 'ExecuteAITeacherSyncDialogueTranslate',
- 'GetAITeacherSyncDialogueSuggestion',
- 'AITeacherExpansionPracticeTaskGenerate',
- 'ExecuteAITeacherExpansionDialogue',
- 'ExecuteAITeacherExpansionDialogueTranslate',
- 'GetAITeacherExpansionDialogueSuggestion',
- 'ExecuteAITeacherExpansionDialogueRefine',
- 'ExecuteAITeacherGrammarCheck',
- ],
+ 'title' => '英语教材式AI老师',
+ 'id' => 451879,
],
- 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList',
[
- 'id' => 194003,
- 'title' => '个性化文生图',
+ 'children' => ['ExecuteAITeacherEnglishParaphraseChatMessage', 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun', 'AITeacherSyncPracticeTaskGenerate', 'ExecuteAITeacherSyncDialogue', 'ExecuteAITeacherSyncDialogueTranslate', 'GetAITeacherSyncDialogueSuggestion', 'AITeacherExpansionPracticeTaskGenerate', 'ExecuteAITeacherExpansionDialogue', 'ExecuteAITeacherExpansionDialogueTranslate', 'GetAITeacherExpansionDialogueSuggestion', 'ExecuteAITeacherExpansionDialogueRefine', 'ExecuteAITeacherGrammarCheck'],
'type' => 'directory',
- 'children' => [
- 'PersonalizedTextToImageQueryPreModelInferenceJobInfo',
- 'PersonalizedTextToImageAddInferenceJob',
- 'PersonalizedTextToImageQueryImageAsset',
- 'Personalizedtxt2imgQueryInferenceJobInfo',
- 'Personalizedtxt2imgAddInferenceJob',
- 'Personalizedtxt2imgAddModelTrainJob',
- 'Personalizedtxt2imgQueryImageAsset',
- 'Personalizedtxt2imgQueryModelTrainJobList',
- 'Personalizedtxt2imgQueryModelTrainStatus',
- ],
+ 'title' => 'AI英语老师',
+ 'id' => 451880,
],
[
- 'id' => 204289,
- 'title' => '其他',
+ 'children' => ['AliyunConsoleOpenApiQueryAliyunConsoleServcieList', 'CountOralEvaluationStatisticsConcurrent', 'CountOralEvaluationStatisticsCalls', 'CountOralEvaluationStatisticsError', 'AliyunConsoleOpenApiQueryPaidResource', 'Personalizedtxt2imgAddInferenceJob', 'Personalizedtxt2imgAddModelTrainJob', 'Personalizedtxt2imgQueryModelTrainJobList', 'Personalizedtxt2imgQueryInferenceJobInfo', 'Personalizedtxt2imgQueryModelTrainStatus', 'Personalizedtxt2imgQueryImageAsset', 'PersonalizedTextToImageQueryPreModelInferenceJobInfo', 'PersonalizedTextToImageQueryImageAsset', 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList', 'PersonalizedTextToImageAddInferenceJob', 'ModelRouterSaveFlowConfig'],
'type' => 'directory',
- 'children' => [
- 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList',
- 'CountOralEvaluationStatisticsConcurrent',
- 'CountOralEvaluationStatisticsCalls',
- 'CountOralEvaluationStatisticsError',
- 'AliyunConsoleOpenApiQueryPaidResource',
- ],
+ 'title' => '其他',
+ 'id' => 451881,
],
],
'components' => [
@@ -106,274 +49,607 @@
'description' => '服务信息结构体',
'type' => 'object',
'properties' => [
- 'serviceCode' => [
- 'title' => '服务编码',
- 'description' => '服务编码',
- 'type' => 'string',
- 'example' => 'online_ai_algorithm_personalized_text_to_image_call_count',
+ 'serviceCode' => ['title' => '服务编码', 'description' => '服务编码', 'type' => 'string', 'example' => 'online_ai_algorithm_personalized_text_to_image_call_count'],
+ 'serviceName' => ['title' => '服务名称', 'description' => '服务名称', 'type' => 'string', 'example' => 'AI算法模型-个性化文生图-在线按量调用'],
+ 'freeCount' => ['title' => '体验调用量', 'description' => '体验调用量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'freeConcurrencyCount' => ['title' => '体验并发数', 'description' => '体验并发数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'documentUrl' => ['title' => '官网文档url', 'description' => '官网文档url', 'type' => 'string', 'example' => 'https://www.aliyun.com/product/ai-algorithm'],
+ 'buyUrl' => ['title' => '服务开通url', 'description' => '服务开通url', 'type' => 'string', 'example' => 'https://www.aliyun.com/product/ai-algorithm'],
+ ],
+ ],
+ 'ApiKeyCreateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'clientId' => ['title' => '客户ID,null表示默认客户', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ ],
+ 'ApiKeyDecryptedDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'name' => ['title' => '密钥名称', 'type' => 'string', 'example' => 'MyApiKey'],
+ 'key' => ['title' => '完整密钥', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxxxxxxx'],
+ 'client' => ['title' => '关联的客户信息', '$ref' => '#/components/schemas/ClientDTO'],
+ 'keyPreview' => ['title' => '密钥预览', 'type' => 'string', 'example' => 'sk-xxx****xxx'],
+ 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ ],
+ 'ApiKeyDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'name' => ['title' => '密钥名称', 'type' => 'string', 'example' => 'MyApiKey'],
+ 'client' => ['title' => '关联的客户信息', '$ref' => '#/components/schemas/ClientDTO'],
+ 'keyPreview' => ['title' => '密钥预览', 'type' => 'string', 'example' => 'sk-xxx****xxx'],
+ 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'deleteTag' => ['title' => '删除标识', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'key' => ['title' => 'key', 'type' => 'string', 'example' => 'key'],
+ ],
+ ],
+ 'ApiKeyListQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'keyword' => ['title' => '搜索关键字', 'type' => 'string'],
+ 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'clientId' => ['title' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ ],
+ 'ApiKeyUpdateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '密钥名称', 'type' => 'string', 'example' => 'MyApiKey'],
+ 'status' => ['title' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
+ ],
+ 'BatchCreateModelItemDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '模型名称(必填,建议同标识重复时手动加 -v1/-v2 区分)', 'type' => 'string', 'required' => true, 'example' => 'qwen-max'],
+ 'modelId' => ['title' => '模型标识(必填,对应厂商侧 model id;同标识重复时由后端自动按 v1/v2 递增 version)', 'type' => 'string', 'required' => true, 'example' => 'qwen-max'],
+ 'modelType' => ['title' => '模型类型(必填)。可选枚举:Chat / Embedding / Rerank / Image / Audio / Video', 'type' => 'string', 'required' => true, 'example' => 'Chat'],
+ 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问 Max'],
+ 'maxInputLength' => ['title' => '最大输入长度(token 数)', 'type' => 'string', 'example' => '128000'],
+ 'maxOutputLength' => ['title' => '最大输出长度(token 数)', 'type' => 'string', 'example' => '8192'],
+ 'inOut' => ['title' => '支持的输入输出数据类型,逗号分隔', 'type' => 'string', 'example' => 'text'],
+ 'extensions' => ['title' => '扩展配置参数,JSON 字符串', 'type' => 'string', 'example' => '{}'],
+ 'tags' => ['title' => '标签,逗号分隔', 'type' => 'string', 'example' => 'chat,NLP'],
+ ],
+ ],
+ 'BatchModelErrorDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'modelId' => ['title' => '模型标识', 'type' => 'string', 'example' => 'qwen-max'],
+ 'name' => ['title' => '模型名称', 'type' => 'string', 'example' => 'qwen-max'],
+ 'errorMsg' => ['title' => '失败原因', 'type' => 'string', 'example' => '模型类型不能为空'],
+ ],
+ ],
+ 'BillingBillSummaryPointDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'timestamp' => ['title' => '时间戳(Unix秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'],
+ 'totalAmount' => ['title' => '该时间点的总费用', 'type' => 'number', 'format' => 'float', 'example' => '1.23'],
+ ],
+ ],
+ 'BillingBillSummaryRespDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'totalAmount' => ['title' => '时间范围内的总费用', 'type' => 'number', 'format' => 'float', 'example' => '123.45'],
+ 'points' => [
+ 'title' => '费用趋势数据点列表',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/BillingBillSummaryPointDTO'],
],
- 'serviceName' => [
- 'title' => '服务名称',
- 'description' => '服务名称',
- 'type' => 'string',
- 'example' => 'AI算法模型-个性化文生图-在线按量调用',
- ],
- 'freeCount' => [
- 'title' => '体验调用量',
- 'description' => '体验调用量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'freeConcurrencyCount' => [
- 'title' => '体验并发数',
- 'description' => '体验并发数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'documentUrl' => [
- 'title' => '官网文档url',
- 'description' => '官网文档url',
- 'type' => 'string',
- 'example' => 'https://www.aliyun.com/product/ai-algorithm',
+ ],
+ ],
+ 'BillingBillTierDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'dimValues' => ['title' => '维度键值映射,key为维度列名,value为展示值', 'type' => 'string', 'example' => '{"context_tier": "0-32k"}'],
+ 'values' => ['title' => '用量数值映射,key为指标名,value为数值', 'type' => 'string', 'example' => '{"input_tokens": 1000, "output_tokens": 500}'],
+ 'payableAmount' => ['title' => '该桶的费用', 'type' => 'number', 'format' => 'float', 'example' => '0.05'],
+ ],
+ ],
+ 'BillingCostBreakdownRespDTO' => [
+ 'description' => '计费明细',
+ 'type' => 'object',
+ 'properties' => [
+ 'granularity' => ['title' => '聚合粒度:hourly 或 daily', 'description' => '聚合粒度:hourly 或 daily', 'type' => 'string', 'example' => 'hourly'],
+ 'page' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'total' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'columns' => [
+ 'title' => '列定义,根据查询结果中出现的模型类型动态生成',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/MetricDefRespDTO'],
+ 'example' => '[]',
],
- 'buyUrl' => [
- 'title' => '服务开通url',
- 'description' => '服务开通url',
- 'type' => 'string',
- 'example' => 'https://www.aliyun.com/product/ai-algorithm',
+ 'rows' => [
+ 'title' => '计费明细数据列表',
+ 'description' => '计费明细数据列表',
+ 'type' => 'array',
+ 'items' => ['description' => '计费单条明细', '$ref' => '#/components/schemas/BillingCostBreakdownRowDTO'],
+ 'example' => '[]',
],
],
],
- 'OpenApiMultiResponse' => [
- 'title' => '通用接口多数据对象返回结构体',
+ 'BillingCostBreakdownRowDTO' => [
+ 'description' => '计费单条明细',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'type' => 'string',
+ 'summaryTime' => ['title' => '统计时间点,Unix时间戳(秒)', 'description' => '统计时间点,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelCode' => ['title' => '模型标识符', 'description' => '模型标识符', 'type' => 'string', 'example' => 'qwen-plus'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'],
+ 'modelType' => ['title' => '统计口径', 'description' => '统计口径', 'type' => 'string', 'example' => 'llm'],
+ 'clientId' => ['title' => '部门ID,0表示无归属部门', 'description' => '部门ID,0表示无归属部门', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'clientName' => ['title' => '部门名称', 'description' => '部门名称', 'type' => 'string', 'example' => '研发部'],
+ 'apiKeyId' => ['title' => 'API Key ID,0 表示历史数据未细分到 ApiKey', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'apiKeyName' => ['title' => 'API Key 名称,对应 api_key_id', 'type' => 'string', 'example' => '默认密钥'],
+ 'billingType' => ['title' => '计费类型,当前固定为 total_amount', 'description' => '计费类型,当前固定为 total_amount', 'type' => 'string', 'example' => 'total_amount'],
+ 'payableAmount' => ['title' => '应付金额,保留8位小数', 'description' => '应付金额,保留8位小数', 'type' => 'number', 'format' => 'float', 'example' => '0.00012800'],
+ 'dimValues' => ['title' => '维度值映射,如计费版本、上下文窗口阶梯等,无维度时省略', 'type' => 'string', 'example' => '{"billing_version": "v1"}'],
+ 'values' => ['title' => '用量+费用分项数值映射,key与columns中的key对应', 'type' => 'string', 'example' => '{"input_tokens": 512000, "output_tokens": 256000}'],
+ 'tiers' => [
+ 'title' => '维度桶子表,按上下文分段等计费时展开,无分段时省略',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/BillingBillTierDTO'],
+ 'example' => '[]',
],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
+ ],
+ ],
+ 'ClientBalanceDTO' => [
+ 'description' => '部门余额',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'clientId' => ['title' => '部门ID', 'description' => '部门ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'balance' => ['title' => '当前余额', 'description' => '当前余额', 'type' => 'number', 'format' => 'double', 'example' => '100.00'],
+ 'balanceType' => ['title' => '余额类型:amount(金额)/ tokens(token数量)', 'description' => '余额类型:amount(金额)/ tokens(token数量)', 'type' => 'string', 'example' => 'amount'],
+ 'enableBalance' => ['title' => '是否启用余额限流', 'description' => '是否启用余额限流', 'type' => 'boolean', 'example' => 'true'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ ],
+ 'ClientBalanceLogDTO' => [
+ 'description' => '余额记录',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => '记录ID', 'description' => '记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'clientId' => ['title' => '部门ID', 'description' => '部门ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'changeAmount' => ['title' => '变更金额(正数=充值,负数=扣费)', 'description' => '变更金额(正数=充值,负数=扣费)', 'type' => 'number', 'format' => 'double', 'example' => '10.00'],
+ 'balanceBefore' => ['title' => '变更前余额', 'description' => '变更前余额', 'type' => 'number', 'format' => 'double', 'example' => '90.00'],
+ 'balanceAfter' => ['title' => '变更后余额', 'description' => '变更后余额', 'type' => 'number', 'format' => 'double', 'example' => '100.00'],
+ 'changeType' => ['title' => '变更类型:auto_deduct/deduct/recharge', 'description' => '变更类型:auto_deduct/deduct/recharge', 'type' => 'string', 'example' => 'recharge'],
+ 'remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => '充值'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ ],
+ 'ClientCreateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户'],
+ 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市'],
+ 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000'],
+ 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注'],
+ 'allowedModels' => ['title' => '允许的模型ID列表,逗号分隔,空表示全部', 'type' => 'string', 'example' => '1,2,3'],
+ ],
+ ],
+ 'ClientDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户'],
+ 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市'],
+ 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000'],
+ 'main' => ['title' => '0=主账户 1=普通账户', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注'],
+ 'clientUuid' => ['title' => '客户唯一标识', 'type' => 'string', 'example' => 'st-xxxx'],
+ 'allowedModels' => ['title' => '允许的模型ID列表,逗号分隔,空表示全部', 'type' => 'string', 'example' => '1,2,3'],
+ 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ ],
+ 'ClientListQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'keyword' => ['title' => '搜索关键字', 'type' => 'string'],
+ 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ ],
+ 'ClientTreeDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户'],
+ 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市'],
+ 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000'],
+ 'main' => ['title' => '0=主账户 1=普通账户', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注'],
+ 'clientUuid' => ['title' => '客户唯一标识', 'type' => 'string', 'example' => 'st-xxxx'],
+ 'allowedModels' => ['title' => '允许的模型ID列表,逗号分隔,空表示全部', 'type' => 'string', 'example' => '1,2,3'],
+ 'discount' => ['title' => '折扣系数,1.0=无折扣,0.8=八折', 'type' => 'number', 'format' => 'double', 'example' => '1.0'],
+ 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'level' => ['title' => '层级 1~5', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'parentId' => ['title' => '父部门ID,NULL=顶层', 'type' => 'integer', 'format' => 'int64', 'example' => 'null'],
+ 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'balance' => ['title' => '余额信息', 'example' => 'null', '$ref' => '#/components/schemas/ClientBalanceDTO'],
+ 'children' => [
+ 'title' => '子客户列表',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/ClientTreeDTO'],
+ 'example' => '[]',
],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'type' => 'string',
+ ],
+ ],
+ 'ClientUpdateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户'],
+ 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市'],
+ 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000'],
+ 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注'],
+ 'status' => ['title' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'allowedModels' => ['title' => '允许的模型ID列表,逗号分隔,空表示全部', 'type' => 'string', 'example' => '1,2,3'],
+ ],
+ ],
+ 'ConversationCreateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'chatData' => ['title' => '对话数据JSON,包含各模型的消息记录(必填)', 'type' => 'string'],
+ 'modelIds' => ['title' => '模型ID列表,JSON数组字符串', 'type' => 'string'],
+ 'title' => ['title' => '对话标题,不传则自动从第一条用户消息提取', 'type' => 'string'],
+ ],
+ ],
+ 'ConversationDTO' => [
+ 'description' => '返回数据结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'title' => ['title' => '标题', 'description' => '标题', 'type' => 'string', 'example' => '我的对话'],
+ 'messageCount' => ['title' => '消息数量', 'description' => '消息数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'modelIds' => ['title' => '模型ID列表JSON', 'description' => '模型ID列表JSON', 'type' => 'string', 'example' => '[1,2,3]'],
+ 'chatData' => ['title' => '完整对话状态JSON', 'description' => '完整对话状态JSON', 'type' => 'string', 'example' => '{}'],
+ 'deleteTag' => ['title' => '0=启用 非0=禁用', 'description' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ ],
+ 'ConversationListQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'keyword' => ['title' => '搜索关键字', 'type' => 'string'],
+ 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ ],
+ ],
+ 'ConversationUpdateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => '对话标题', 'type' => 'string', 'example' => '我的对话'],
+ 'chatData' => ['title' => '对话数据JSON,包含各模型的消息记录', 'type' => 'string', 'example' => '{"messages":[{"role":"user","content":"你好"}]}'],
+ 'messageCount' => ['title' => '消息数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'modelIds' => ['title' => '模型ID列表,JSON数组字符串', 'type' => 'string', 'example' => '[1,2,3]'],
+ ],
+ ],
+ 'CostModelDetailRespDTO' => [
+ 'description' => '模型用量详情列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'columns' => [
+ 'title' => '列定义列表',
+ 'description' => '列定义列表',
+ 'type' => 'array',
+ 'items' => ['description' => '列', '$ref' => '#/components/schemas/MetricDefRespDTO'],
+ ],
+ 'granularity' => ['title' => '当前粒度:daily/hourly', 'description' => '当前粒度:daily/hourly', 'type' => 'string', 'example' => 'hourly'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'],
+ 'page' => ['title' => '当前页', 'description' => '当前页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'rows' => [
+ 'title' => '数据行列表',
+ 'description' => '数据行列表',
+ 'type' => 'array',
+ 'items' => ['description' => '行', '$ref' => '#/components/schemas/CostModelDetailRowDTO'],
],
- 'errMessage' => [
- 'title' => '错误信息',
- 'type' => 'string',
+ 'total' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ ],
+ ],
+ 'CostModelDetailRowDTO' => [
+ 'description' => '用量明细结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'timestamp' => ['title' => '时间戳(Unix秒)', 'description' => '时间戳(Unix秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'],
+ 'values' => ['title' => '指标值映射,key为指标名,value为数值', 'description' => '指标值映射,key为指标名,value为数值', 'type' => 'string', 'example' => '"{\\"total_calls\\":3,\\"video_duration\\":0,\\"total_amount\\":0.6,\\"image_count\\":3,\\"timestamp\\":1776787200}"'],
+ ],
+ ],
+ 'CostQueryModelsDTO' => [
+ 'description' => '模型用量表结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'columns' => [
+ 'title' => '列定义列表',
+ 'description' => '列定义列表',
+ 'type' => 'array',
+ 'items' => ['description' => '列', '$ref' => '#/components/schemas/MetricDefRespDTO'],
],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'idField' => ['title' => 'ID字段名', 'description' => 'ID字段名', 'type' => 'string', 'example' => 'model_id'],
+ 'nameField' => ['title' => '名称字段名', 'description' => '名称字段名', 'type' => 'string', 'example' => 'model_name'],
+ 'rows' => [
+ 'title' => '模型数据行列表',
+ 'description' => '模型数据行列表',
+ 'type' => 'array',
+ 'items' => ['description' => '行', '$ref' => '#/components/schemas/ModelRowDTO'],
],
- 'data' => [
- 'title' => '数据列表',
+ ],
+ ],
+ 'CostQueryTrendDTO' => [
+ 'description' => '用量趋势结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'defaultMetric' => ['title' => '默认指标', 'description' => '默认指标', 'type' => 'string', 'example' => 'total_amount'],
+ 'granularity' => ['title' => '粒度:hourly或daily', 'description' => '粒度:hourly或daily', 'type' => 'string', 'example' => 'hourly'],
+ 'metrics' => [
+ 'title' => '指标定义列表',
+ 'description' => '指标定义列表',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'title' => '模型训练任务id',
- 'type' => 'string',
- 'example' => '456',
- ],
- 'modelId' => [
- 'title' => '模型id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
- 'name' => [
- 'title' => '模型训练任务名称',
- 'type' => 'string',
- 'example' => '可爱熊猫模型训练任务',
- ],
- 'objectType' => [
- 'title' => '模型训练任务训练主体',
- 'type' => 'string',
- 'example' => 'panda',
- ],
- 'imageUrl' => [
- 'title' => '模型训练任务图片地址列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'jobStatus' => [
- 'title' => '模型训练任务状态',
- 'type' => 'string',
- 'example' => 'TRAINING',
- 'enum' => [
- 'FINISHED',
- 'TRAINING',
- 'TRAINING_TERMINATED',
- 'WRONG_IMAGE_URL',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型训练任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
- ],
- 'inferenceJobList' => [
- 'title' => '模型推理任务列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
- 'jobStatus' => [
- 'title' => '模型推理任务状态',
- 'type' => 'string',
- 'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
- ],
- 'resultImageUrl' => [
- 'title' => '模型推理任务结果列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'example' => '0000.png',
- ],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
- ],
- ],
- ],
- 'inferenceImageCount' => [
- 'title' => '该模型总推理图片数量',
- 'type' => 'integer',
- 'format' => 'int32',
- ],
- 'createTime' => [
- 'title' => '模型训练任务创建时间',
- 'type' => 'string',
- ],
- ],
- ],
- 'example' => '[]',
+ 'items' => ['description' => '指标定义', '$ref' => '#/components/schemas/MetricDefRespDTO'],
+ ],
+ 'points' => [
+ 'title' => '趋势数据点列表',
+ 'description' => '趋势数据点列表',
+ 'type' => 'array',
+ 'items' => ['description' => '点对象', '$ref' => '#/components/schemas/TrendPointDTO'],
],
],
],
- 'OpenApiSingleResponse' => [
- 'title' => '通用接口单数据对象返回结构体',
+ 'CostTabDTO' => [
+ 'description' => '用量标签结构体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'type' => 'string',
+ 'key' => ['title' => 'Tab唯一标识', 'description' => 'Tab唯一标识', 'type' => 'string', 'example' => 'all'],
+ 'label' => ['title' => 'Tab显示名称', 'description' => 'Tab显示名称', 'type' => 'string', 'example' => '全部'],
+ 'modelTypes' => [
+ 'title' => '关联的模型类型列表',
+ 'description' => '关联的模型类型列表',
+ 'type' => 'array',
+ 'items' => ['description' => '模型类型名称', 'type' => 'string', 'example' => 'Chat'],
],
- 'success' => [
- 'title' => '是否成功',
- 'type' => 'boolean',
+ ],
+ ],
+ 'MetricDefRespDTO' => [
+ 'description' => '指标结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['title' => '指标键名', 'description' => '指标键名', 'type' => 'string', 'example' => 'total_calls'],
+ 'label' => ['title' => '指标显示名称', 'description' => '指标显示名称', 'type' => 'string', 'example' => '调用次数'],
+ 'sortable' => ['title' => '是否可排序', 'description' => '是否可排序', 'type' => 'boolean', 'example' => 'true'],
+ 'unit' => ['title' => '指标单位', 'description' => '指标单位', 'type' => 'string', 'example' => '次'],
+ ],
+ ],
+ 'MetricKVPairDTO' => [
+ 'description' => '指标',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['title' => '指标名称', 'description' => '指标名称。'."\n"
+ ."\n"
+ .'**Chat**'."\n"
+ .'- `total_calls`:调用次数,整数,次'."\n"
+ .'- `input_tokens`:输入 Token 总量,整数'."\n"
+ .'- `output_tokens`:输出 Token 总量,整数'."\n"
+ .'- `reasoning_tokens`:推理过程 Token,整数'."\n"
+ .'- `cached_tokens`:命中缓存的输入 Token,整数'."\n"
+ ."\n"
+ .'**视觉**'."\n"
+ .'- `total_calls`:调用次数,整数,次'."\n"
+ .'- `image_count`:生成图片张数,整数'."\n"
+ .'- `video_duration`:生成视频时长,保留 3 位小数,秒'."\n"
+ ."\n"
+ .'**向量**'."\n"
+ .'- `total_calls`:调用次数,整数,次'."\n"
+ .'- `embedding_output_tokens`:向量化输出 Token,整数'."\n"
+ .'- `billing_tokens`:总计费 Token 数,整数'."\n"
+ .'- `image_tokens`:图片 Token(多模态 Embedding),整数'."\n"
+ ."\n"
+ .'**全模态(ChatFullmodal / ChatMultimodal)**'."\n"
+ .'- `total_calls`:调用次数,整数,次'."\n"
+ .'- `input_text_tokens`:输入文本 Token,整数'."\n"
+ .'- `input_audio_tokens`:输入音频 Token,整数'."\n"
+ .'- `input_image_tokens`:输入图片 Token,整数'."\n"
+ .'- `input_video_tokens`:输入视频 Token,整数'."\n"
+ .'- `output_text_tokens`:输出文本 Token,整数'."\n"
+ .'- `output_audio_tokens`:输出音频 Token,整数'."\n"
+ ."\n"
+ .'**语音(TTS / ASR)**'."\n"
+ .'- `total_calls`:调用次数,整数,次'."\n"
+ .'- `characters`:转语音字符数,整数'."\n"
+ .'- `asr_duration`:语音识别时长,保留 3 位小数,秒', 'type' => 'string', 'example' => 'total_calls'],
+ 'value' => ['title' => '指标数值', 'description' => '指标数值', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ ],
+ ],
+ 'MetricValueDTO' => [
+ 'description' => '概览指标结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'key' => ['title' => '指标键名', 'description' => '指标键名', 'type' => 'string', 'example' => 'total_calls'],
+ 'label' => ['title' => '指标显示名称', 'description' => '指标显示名称', 'type' => 'string', 'example' => '调用次数'],
+ 'unit' => ['title' => '指标单位', 'description' => '指标单位', 'type' => 'string', 'example' => '次'],
+ 'value' => ['title' => '指标值', 'description' => '指标值', 'type' => 'number', 'format' => 'float', 'example' => '100'],
+ ],
+ ],
+ 'ModelCreateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '模型名称', 'type' => 'string', 'example' => '通义千问'],
+ 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问大模型'],
+ 'symbol' => ['title' => '厂商symbol', 'type' => 'string', 'example' => 'alibaba'],
+ 'tags' => ['title' => '标签,逗号分隔', 'type' => 'string', 'example' => 'chat,NLP'],
+ 'modelId' => ['title' => '模型标识', 'type' => 'string', 'example' => 'qwen-turbo'],
+ 'modelType' => ['title' => '模型类型', 'type' => 'string', 'example' => 'Chat'],
+ 'apiKey' => ['title' => 'API Key', 'type' => 'string', 'example' => 'sk-xxxx'],
+ 'baseUrl' => ['title' => 'Base URL', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'],
+ 'maxInputLength' => ['title' => '最大输入长度', 'type' => 'string', 'example' => '8192'],
+ 'maxOutputLength' => ['title' => '最大输出长度', 'type' => 'string', 'example' => '2048'],
+ ],
+ ],
+ 'ModelDTO' => [
+ 'description' => '返回数据结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'name' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问'],
+ 'description' => ['title' => '模型描述', 'description' => '模型描述', 'type' => 'string', 'example' => '通义千问大模型'],
+ 'symbol' => ['title' => '厂商symbol', 'description' => '厂商symbol', 'type' => 'string', 'example' => 'alibaba'],
+ 'tags' => ['title' => '标签,逗号分隔', 'description' => '标签,逗号分隔', 'type' => 'string', 'example' => 'chat,NLP'],
+ 'modelCode' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'example' => 'qwen-turbo'],
+ 'modelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'example' => 'Chat'],
+ 'apiKeyPreview' => ['title' => 'API密钥预览', 'description' => 'API密钥预览', 'type' => 'string', 'example' => 'sk-xxx****xxx'],
+ 'baseUrl' => ['title' => 'Base URL', 'description' => 'Base URL', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'],
+ 'maxInputLength' => ['title' => '最大输入长度', 'description' => '最大输入长度', 'type' => 'string', 'example' => '8192'],
+ 'maxOutputLength' => ['title' => '最大输出长度', 'description' => '最大输出长度', 'type' => 'string', 'example' => '2048'],
+ 'isCustom' => ['title' => '是否为自定义', 'description' => '是否为自定义', 'type' => 'boolean', 'example' => 'false'],
+ 'tagNames' => ['title' => '标签显示名称', 'description' => '标签显示名称', 'type' => 'string', 'example' => '对话,自然语言处理'],
+ 'deleteTag' => ['title' => '0=启用 非0=禁用', 'description' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'description' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'version' => ['title' => '版本', 'description' => '版本', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'hasBillingRule' => ['title' => '是否已配置计费规则', 'type' => 'boolean', 'example' => 'false'],
+ 'inOut' => ['type' => 'string'],
+ 'extensions' => ['type' => 'string'],
+ ],
+ ],
+ 'ModelListQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'keyword' => ['title' => '搜索关键字', 'type' => 'string'],
+ 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ ],
+ ],
+ 'ModelMetricsDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'totalCalls' => ['title' => '总调用量', 'type' => 'integer', 'format' => 'int64', 'example' => '1000'],
+ 'successRate' => ['title' => '成功率(%)', 'type' => 'number', 'format' => 'double', 'example' => '99.5'],
+ 'avgResponseTime' => ['title' => '平均响应时间 (ms)', 'type' => 'number', 'format' => 'double', 'example' => '200.5'],
+ 'inputTokens' => ['title' => '输入 Token 总数', 'type' => 'integer', 'format' => 'int64', 'example' => '500000'],
+ 'outputTokens' => ['title' => '输出 Token 总数', 'type' => 'integer', 'format' => 'int64', 'example' => '300000'],
+ ],
+ ],
+ 'ModelRowDTO' => [
+ 'description' => '行结构',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelCode' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'example' => 'qwen-plus'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'],
+ 'values' => ['title' => '指标值映射,key为指标名,value为数值', 'description' => '指标值映射,key为指标名,value为数值', 'type' => 'string', 'example' => '"{\\"total_calls\\":21,\\"video_duration\\":210,\\"total_amount\\":126,\\"image_count\\":0}"'],
+ ],
+ ],
+ 'ModelUpdateCmd' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '模型名称', 'type' => 'string', 'example' => '通义千问'],
+ 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问大模型'],
+ 'status' => ['title' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'symbol' => ['title' => '厂商symbol', 'type' => 'string', 'example' => 'alibaba'],
+ 'tags' => ['title' => '标签,逗号分隔', 'type' => 'string', 'example' => 'chat,NLP'],
+ 'modelId' => ['title' => '模型标识', 'type' => 'string', 'example' => 'qwen-turbo'],
+ 'modelType' => ['title' => '模型类型', 'type' => 'string', 'example' => 'Chat'],
+ 'apiKey' => ['title' => 'API Key', 'type' => 'string', 'example' => 'sk-xxxx'],
+ 'baseUrl' => ['title' => 'Base URL', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'],
+ 'maxInputLength' => ['title' => '最大输入长度', 'type' => 'string', 'example' => '8192'],
+ 'maxOutputLength' => ['title' => '最大输出长度', 'type' => 'string', 'example' => '2048'],
+ ],
+ ],
+ 'ObservationChartsDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'qpm' => [
+ 'title' => 'QPM 时间序列',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO'],
],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'type' => 'string',
+ 'tpm' => [
+ 'title' => 'TPM 时间序列',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO'],
],
- 'errMessage' => [
- 'title' => '错误信息',
- 'type' => 'string',
+ 'concurrency' => [
+ 'title' => '并发连接数',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO'],
],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'callVolume' => [
+ 'title' => '调用量时间序列',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO'],
],
- 'data' => [
- 'title' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'modelTrainStatus' => [
- 'title' => '模型训练状态',
- 'type' => 'string',
- 'example' => 'FINISHED',
+ 'successRate' => [
+ 'title' => '成功率时间序列',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'timestamp' => ['title' => '时间戳(RFC3339)', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'value' => ['title' => '值', 'type' => 'any'],
+ 'label' => ['title' => '标签', 'type' => 'string', 'example' => 'series1'],
],
],
- 'example' => '[]',
],
+ 'responseTime' => [
+ 'title' => '响应时间时间序列',
+ 'type' => 'array',
+ 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO'],
+ ],
+ ],
+ ],
+ 'ObservationLogListQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'clientId' => ['title' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'apiKeyId' => ['title' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelId' => ['title' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'timeRange' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'example' => '24h'],
+ 'startTime' => ['title' => '自定义开始时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'endTime' => ['title' => '自定义结束时间', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z'],
+ ],
+ ],
+ 'ObservationQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'clientId' => ['title' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'apiKeyId' => ['title' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelId' => ['title' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'timeRange' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'example' => '24h'],
+ 'startTime' => ['title' => '自定义开始时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'endTime' => ['title' => '自定义结束时间', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z'],
],
],
'OralEvaluationStatisticsCallsCountRequest' => [
'description' => '调用量统计请求体对象',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'startTime' => [
- 'title' => '起始时间',
- 'description' => '起始时间',
- 'type' => 'string',
- 'example' => '2024-10-14 07:40:01',
- ],
- 'endTime' => [
- 'title' => '截止时间',
- 'description' => '截止时间',
- 'type' => 'string',
- 'example' => '2024-10-15 07:40:01'."\n",
- ],
- 'granularity' => [
- 'title' => '查询颗粒度(小时、天,月)',
- 'description' => '查询颗粒度(小时、天,月)',
- 'type' => 'string',
- 'example' => 'DAY',
- ],
- 'applicationAccessId' => [
- 'title' => 'appId,appkey',
- 'description' => 'appId,appkey',
- 'type' => 'string',
- 'example' => 'a0007g7',
- ],
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '123'],
+ 'startTime' => ['title' => '起始时间', 'description' => '起始时间', 'type' => 'string', 'example' => '2024-10-14 07:40:01'],
+ 'endTime' => ['title' => '截止时间', 'description' => '截止时间', 'type' => 'string', 'example' => '2024-10-15 07:40:01'."\n"],
+ 'granularity' => ['title' => '查询颗粒度(小时、天,月)', 'description' => '查询颗粒度(小时、天,月)', 'type' => 'string', 'example' => 'DAY'],
+ 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'example' => 'a0007g7'],
],
],
'OralEvaluationStatisticsCallsCountResponse' => [
@@ -381,25 +657,13 @@
'description' => '调用量统计响应体对象',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'required' => true, 'example' => '123'],
'projectData' => [
'title' => '项目统计数据',
'description' => '项目统计数据',
'type' => 'object',
'properties' => [
- 'applicationInternalId' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '11',
- ],
+ 'applicationInternalId' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'required' => true, 'example' => '11'],
'ApplicationData' => [
'title' => '应用数据对象列表',
'description' => '应用数据对象列表',
@@ -408,13 +672,7 @@
'description' => '应用数据对象',
'type' => 'object',
'properties' => [
- 'applicationAccessId' => [
- 'title' => 'appkey',
- 'description' => 'appkey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a0007g7',
- ],
+ 'applicationAccessId' => ['title' => 'appkey', 'description' => 'appkey', 'type' => 'string', 'required' => true, 'example' => 'a0007g7'],
'Data' => [
'title' => '统计项列表',
'description' => '数据对象列表',
@@ -423,21 +681,8 @@
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '统计项名称',
- 'description' => '统计项名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-01',
- ],
- 'count' => [
- 'title' => '统计项数量',
- 'description' => '统计项数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '2',
- ],
+ 'name' => ['title' => '统计项名称', 'description' => '统计项名称', 'type' => 'string', 'required' => true, 'example' => '2025-01'],
+ 'count' => ['title' => '统计项数量', 'description' => '统计项数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'],
],
],
],
@@ -453,36 +698,11 @@
'description' => '并发数统计请求体对象',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'startTime' => [
- 'title' => '起始时间',
- 'description' => '起始时间',
- 'type' => 'string',
- 'example' => '2024-09-29 05:00:01',
- ],
- 'endTime' => [
- 'title' => '截止时间',
- 'description' => '截止时间',
- 'type' => 'string',
- 'example' => '2024-09-29 14:22:48',
- ],
- 'granularity' => [
- 'title' => '查询颗粒度(小时、天,月)',
- 'description' => '查询颗粒度(小时、天,月)',
- 'type' => 'string',
- 'example' => 'DAY',
- ],
- 'applicationAccessId' => [
- 'title' => 'appId,appkey',
- 'description' => 'appId,appkey',
- 'type' => 'string',
- 'example' => 'a0007g7',
- ],
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '123'],
+ 'startTime' => ['title' => '起始时间', 'description' => '起始时间', 'type' => 'string', 'example' => '2024-09-29 05:00:01'],
+ 'endTime' => ['title' => '截止时间', 'description' => '截止时间', 'type' => 'string', 'example' => '2024-09-29 14:22:48'],
+ 'granularity' => ['title' => '查询颗粒度(小时、天,月)', 'description' => '查询颗粒度(小时、天,月)', 'type' => 'string', 'example' => 'DAY'],
+ 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'example' => 'a0007g7'],
],
],
'OralEvaluationStatisticsConcurrentCountResponse' => [
@@ -490,25 +710,13 @@
'description' => '并发数统计响应体对象',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'required' => true, 'example' => '123'],
'projectData' => [
'title' => '项目统计数据',
'description' => '项目统计数据',
'type' => 'object',
'properties' => [
- 'applicationInternalId' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '11',
- ],
+ 'applicationInternalId' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'required' => true, 'example' => '11'],
'ApplicationData' => [
'title' => '应用数据对象列表',
'description' => '数据列表',
@@ -516,13 +724,7 @@
'items' => [
'type' => 'object',
'properties' => [
- 'applicationAccessId' => [
- 'title' => 'appkey',
- 'description' => 'appkey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a0007g7',
- ],
+ 'applicationAccessId' => ['title' => 'appkey', 'description' => 'appkey', 'type' => 'string', 'required' => true, 'example' => 'a0007g7'],
'Data' => [
'title' => '统计项列表',
'description' => '数据列表',
@@ -531,24 +733,13 @@
'description' => '数据节点对象',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '统计项名称',
- 'description' => '统计项名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-01',
- ],
- 'count' => [
- 'title' => '统计项数量',
- 'description' => '统计项数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- ],
+ 'name' => ['title' => '统计项名称', 'description' => '统计项名称', 'type' => 'string', 'required' => true, 'example' => '2025-01'],
+ 'count' => ['title' => '统计项数量', 'description' => '统计项数量', 'type' => 'integer', 'format' => 'int32', 'required' => true],
],
],
],
],
+ 'description' => '',
],
],
],
@@ -560,70 +751,29 @@
'description' => '口语评测错误码请求体对象',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '123',
- ],
- 'startTime' => [
- 'title' => '起始时间',
- 'description' => '起始时间',
- 'type' => 'string',
- 'example' => '2024-09-27 09:32:00',
- ],
- 'endTime' => [
- 'title' => '截止时间',
- 'description' => '截止时间',
- 'type' => 'string',
- 'example' => '2024-08-22 06:24:53',
- ],
- 'granularity' => [
- 'title' => '查询颗粒度(小时、天,月)',
- 'description' => '查询颗粒度(小时、天,月)',
- 'type' => 'string',
- 'example' => 'DAY',
- ],
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '123'],
+ 'startTime' => ['title' => '起始时间', 'description' => '起始时间', 'type' => 'string', 'example' => '2024-09-27 09:32:00'],
+ 'endTime' => ['title' => '截止时间', 'description' => '截止时间', 'type' => 'string', 'example' => '2024-08-22 06:24:53'],
+ 'granularity' => ['title' => '查询颗粒度(小时、天,月)', 'description' => '查询颗粒度(小时、天,月)', 'type' => 'string', 'example' => 'DAY'],
'errorCode' => [
'title' => '错误码',
'description' => '错误码列表',
'type' => 'array',
- 'items' => [
- 'description' => '错误码。',
- 'type' => 'string',
- 'example' => '51000',
- ],
- ],
- 'applicationAccessId' => [
- 'title' => 'appId,appkey',
- 'description' => 'appId,appkey',
- 'type' => 'string',
- 'example' => 'a0007g7',
+ 'items' => ['description' => '错误码。', 'type' => 'string', 'example' => '51000'],
],
+ 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'example' => 'a0007g7'],
],
],
'OralEvaluationStatisticsErrorCountResponse' => [
'description' => '错误码统计返回结构体对象',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '123',
- ],
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'required' => true, 'example' => '123'],
'ProjectData' => [
'description' => '按项目汇总的统计项列表',
'type' => 'object',
'properties' => [
- 'applicationInternalId' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '1',
- ],
+ 'applicationInternalId' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'required' => true, 'example' => '1'],
'ApplicationData' => [
'description' => '应用的统计项数据对象列表',
'type' => 'array',
@@ -631,13 +781,7 @@
'description' => '应用的统计项数据对象',
'type' => 'object',
'properties' => [
- 'applicationAccessId' => [
- 'title' => 'appId,appkey',
- 'description' => 'appId,appkey',
- 'type' => 'string',
- 'required' => true,
- 'example' => 't000797',
- ],
+ 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'required' => true, 'example' => 't000797'],
'Data' => [
'description' => '数据集列表',
'type' => 'array',
@@ -645,16 +789,8 @@
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'ErrorCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '51000',
- ],
- 'ErrorMessage' => [
- 'description' => '错误码描述信息',
- 'type' => 'string',
- 'example' => 'start the core unsuccessfull.',
- ],
+ 'ErrorCode' => ['description' => '错误码', 'type' => 'string', 'example' => '51000'],
+ 'ErrorMessage' => ['description' => '错误码描述信息', 'type' => 'string', 'example' => 'start the core unsuccessfull.'],
'Data' => [
'description' => '统计项列表',
'type' => 'array',
@@ -662,21 +798,8 @@
'description' => '统计项数据',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '统计项名称,展示颗粒度',
- 'description' => '统计项名称,展示颗粒度',
- 'type' => 'string',
- 'required' => true,
- 'example' => '2025-02',
- ],
- 'count' => [
- 'title' => '统计项数量',
- 'description' => '统计项数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '230',
- ],
+ 'name' => ['title' => '统计项名称,展示颗粒度', 'description' => '统计项名称,展示颗粒度', 'type' => 'string', 'required' => true, 'example' => '2025-02'],
+ 'count' => ['title' => '统计项数量', 'description' => '统计项数量', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '230'],
],
],
],
@@ -690,243 +813,163 @@
],
],
],
+ 'OrgInitResultDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'orgId' => ['title' => '企业ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'userId' => ['title' => '用户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'clientUuid' => ['title' => '客户唯一标识', 'type' => 'string', 'example' => 'st-xxxx'],
+ 'apiKey' => ['title' => '返回明文 API Key,仅初始化时可见一次', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxx'],
+ 'isNew' => ['title' => '是否为新创建(false 表示已存在)', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ ],
'PaidResourceDTO' => [
'description' => '已付费资源对象',
'type' => 'object',
'properties' => [
- 'instanceId' => [
- 'title' => '实例Id',
- 'description' => '实例Id',
- 'type' => 'string',
- 'example' => 'airec-cn-fou41hse8001',
- ],
- 'resourcePackageCode' => [
- 'title' => '资源包编码',
- 'description' => '资源包编码',
- 'type' => 'string',
- 'example' => 'PRE_PAID_RECOURSE_PACKAGE',
- ],
- 'resourcePackageName' => [
- 'title' => '资源包名称',
- 'description' => '资源包名称',
- 'type' => 'string',
- 'example' => '智能批改-资源包',
- ],
- 'resourceCatalogCode' => [
- 'title' => '资源类型',
- 'description' => '资源类型',
- 'type' => 'string',
- 'example' => 'AI_ORAL',
- ],
- 'resourceCatalogName' => [
- 'title' => '资源类型名称',
- 'description' => '资源类型名称',
- 'type' => 'string',
- 'example' => '口语评测',
- ],
+ 'instanceId' => ['title' => '实例Id', 'description' => '实例Id', 'type' => 'string', 'example' => 'airec-cn-fou41hse8001'],
+ 'resourcePackageCode' => ['title' => '资源包编码', 'description' => '资源包编码', 'type' => 'string', 'example' => 'PRE_PAID_RECOURSE_PACKAGE'],
+ 'resourcePackageName' => ['title' => '资源包名称', 'description' => '资源包名称', 'type' => 'string', 'example' => '智能批改-资源包'],
+ 'resourceCatalogCode' => ['title' => '资源类型', 'description' => '资源类型', 'type' => 'string', 'example' => 'AI_ORAL'],
+ 'resourceCatalogName' => ['title' => '资源类型名称', 'description' => '资源类型名称', 'type' => 'string', 'example' => '口语评测'],
'resourceStatus' => [
'title' => '资源状态',
'description' => '资源状态',
'type' => 'string',
- 'enumValueTitles' => [
- 'ALL' => '所有',
- 'ACTIVE' => '有效',
- 'INVALID' => '无效',
- ],
+ 'enumValueTitles' => ['ALL' => '所有', 'ACTIVE' => '有效', 'INVALID' => '无效'],
'example' => 'ACTIVE',
],
- 'quantity' => [
- 'title' => '总量',
- 'description' => '总量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10000',
- ],
- 'remainQuantity' => [
- 'title' => '余量',
- 'description' => '余量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1000',
- ],
- 'effectiveTime' => [
- 'title' => '生效时间',
- 'description' => '生效时间',
- 'type' => 'string',
- 'example' => '2025-09-01 00:00:00',
- ],
- 'expireTime' => [
- 'title' => '失效时间',
- 'description' => '失效时间',
- 'type' => 'string',
- 'example' => '2025-09-10 00:00:00',
- ],
+ 'quantity' => ['title' => '总量', 'description' => '总量', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'],
+ 'remainQuantity' => ['title' => '余量', 'description' => '余量', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'],
+ 'effectiveTime' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2025-09-01 00:00:00'],
+ 'expireTime' => ['title' => '失效时间', 'description' => '失效时间', 'type' => 'string', 'example' => '2025-09-10 00:00:00'],
],
],
- 'PaidResourceQry' => [
+ 'RequestLogDTO' => [
'type' => 'object',
'properties' => [
- 'resourceStatus' => [
- 'title' => 'ALL, AVAILABLE, UNAVAILABLE',
- 'type' => 'string',
- ],
- 'nextToken' => [
- 'type' => 'string',
- ],
- 'maxResults' => [
- 'type' => 'integer',
- 'format' => 'int32',
- ],
+ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'requestId' => ['title' => '请求ID', 'type' => 'string', 'example' => 'req-xxxx'],
+ 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'apiKeyId' => ['title' => 'API Key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelId' => ['title' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelName' => ['title' => '模型名称', 'type' => 'string', 'example' => '通义千问'],
+ 'requestTime' => ['title' => '请求时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'responseTimeMs' => ['title' => '响应时间(ms)', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'statusCode' => ['title' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'promptTokens' => ['title' => '输入Token', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'completionTokens' => ['title' => '输出Token', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'totalTokens' => ['title' => '总Token', 'type' => 'integer', 'format' => 'int32', 'example' => '150'],
+ 'requestBody' => ['title' => '请求体', 'type' => 'string', 'example' => '{}'],
+ 'responseBody' => ['title' => '响应体', 'type' => 'string', 'example' => '{}'],
+ 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'modelCode' => ['title' => '模型', 'type' => 'string', 'example' => 'qwen3-max'],
+ 'symbol' => ['title' => '标记', 'type' => 'string', 'example' => 'qwen'],
+ 'clientUuid' => ['title' => 'client的唯一标识', 'type' => 'string', 'example' => 'mt_xxxxxMYTX9'],
+ 'status' => ['title' => '状态', 'type' => 'string', 'example' => 'success'],
+ 'modelType' => ['title' => '模型类型', 'type' => 'string', 'example' => 'Chat'],
+ 'usage' => ['title' => '使用量统计', 'example' => '{"prompt_tokens":100,"completion_tokens":50,"total_tokens":150}', '$ref' => '#/components/schemas/UsageInfoDTO'],
+ ],
+ ],
+ 'RequestLogListQry' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'keyword' => ['title' => '搜索关键字', 'type' => 'string'],
+ 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
],
],
- 'Personalizedtxt2imgAddInferenceJobCmd' => [
+ 'TimeSeriesPointDTO' => [
'type' => 'object',
'properties' => [
- 'modelId' => [
- 'title' => '模型训练任务id, 指定要用哪个模型进行推理',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx-xxxx-xxxx',
- ],
- 'prompt' => [
- 'title' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a <special-token> in the snow',
- ],
- 'imageNumber' => [
- 'title' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'seed' => [
- 'title' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
+ 'timestamp' => ['title' => '时间戳(RFC3339)', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'value' => ['title' => '值', 'type' => 'any'],
+ 'label' => ['title' => '标签', 'type' => 'string', 'example' => 'series1'],
],
],
- 'Personalizedtxt2imgAddModelTrainJobCmd' => [
+ 'TrendPointDTO' => [
+ 'description' => '趋势点结构',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '模型训练任务名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '熊猫图片生成',
- ],
- 'objectType' => [
- 'title' => '图片中目标的类型, 用一个单词表示, 例如上图中目标为一个小女孩,则object_type可以是“girl”,“person”等。其他类别包括“man”, "boy", "dog"等',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dog',
- ],
- 'imageUrl' => [
- 'title' => '包含图片链接的列表, 可包含单张或多张图片的链接, 如["url_1", "url_2", ...]',
- 'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'required' => true,
- ],
+ 'timestamp' => ['title' => '时间戳(Unix秒)', 'description' => '时间戳(Unix秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'],
+ 'values' => ['title' => '指标值映射,key为指标名,value为数值', 'description' => '指标值映射,key为指标名,value为数值', 'type' => 'string', 'example' => '"{\\"total_calls\\":0,\\"video_duration\\":0,\\"total_amount\\":0,\\"model_count\\":0,\\"image_count\\":0}"'],
],
],
- 'Personalizedtxt2imgInferenceJobInfoDTO' => [
+ 'UsageBreakdownRespDTO' => [
+ 'description' => '用量明细结构',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'jobStatus' => [
- 'title' => '模型推理任务状态',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'resultImageUrl' => [
- 'title' => '模型推理任务结果列表',
+ 'granularity' => ['title' => '聚合粒度:hourly 或 daily', 'description' => '聚合粒度:hourly 或 daily', 'type' => 'string', 'example' => 'hourly'],
+ 'page' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'total' => ['title' => '总条数', 'description' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ 'rows' => [
+ 'title' => '明细数据列表',
+ 'description' => '明细数据列表',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- 'example' => '123456',
- ],
- 'createUserId' => [
- 'title' => '模型推理任务创建用户uid',
- 'type' => 'string',
- 'example' => '123456',
+ 'items' => ['description' => '用量明细单条数据', '$ref' => '#/components/schemas/UsageBreakdownRowDTO'],
+ 'example' => '[]',
],
],
],
- 'Personalizedtxt2imgModelTrainJobInfoDTO' => [
+ 'UsageBreakdownRowDTO' => [
+ 'description' => '用量单条数据结构',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型训练任务id',
- 'type' => 'string',
- 'example' => '123456',
- ],
- 'Name' => [
- 'type' => 'string',
- ],
- 'ObjectType' => [
- 'type' => 'string',
- ],
- 'ImageUrl' => [
+ 'summaryTime' => ['title' => '统计时间点,Unix时间戳(秒)', 'description' => '统计时间点,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelCode' => ['title' => '模型标识符', 'description' => '模型标识符', 'type' => 'string', 'example' => 'qwen-plus'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'],
+ 'modelType' => ['title' => '统计口径', 'description' => '统计口径', 'type' => 'string', 'example' => 'llm'],
+ 'clientId' => ['title' => '部门ID,0表示无归属部门', 'description' => '部门ID,0表示无归属部门', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'clientName' => ['title' => '部门名称', 'description' => '部门名称', 'type' => 'string', 'example' => '研发部'],
+ 'apiKeyId' => ['title' => 'API Key ID,0 表示历史数据未细分到 ApiKey', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'apiKeyName' => ['title' => 'API Key 名称,对应 api_key_id', 'type' => 'string', 'example' => '默认密钥'],
+ 'metrics' => [
+ 'title' => '用量指标数组,仅包含值不为0的条目',
+ 'description' => '用量指标数组,仅包含值不为0的条目',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
- ],
- 'JobStatus' => [
- 'type' => 'string',
- ],
- 'InferenceJobList' => [
- 'type' => 'array',
- 'items' => [
- '$ref' => '#/components/schemas/Personalizedtxt2imgInferenceJobInfoDTO',
- ],
- ],
- 'CreateTime' => [
- 'type' => 'string',
- ],
- 'CreateUserId' => [
- 'type' => 'string',
+ 'items' => ['description' => '指标', '$ref' => '#/components/schemas/MetricKVPairDTO'],
+ 'example' => '[{"key": "total_calls", "value": 100}]',
],
],
],
+ 'UsageInfoDTO' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'promptTokens' => ['title' => '输入Token', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'completionTokens' => ['title' => '输出Token', 'type' => 'integer', 'format' => 'int32', 'example' => '50'],
+ 'totalTokens' => ['title' => '总Token', 'type' => 'integer', 'format' => 'int32', 'example' => '150'],
+ 'imageCount' => ['title' => '图片数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'videoCount' => ['title' => '视频数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'videoDuration' => ['title' => '视频时长(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ ],
+ ],
],
],
'apis' => [
- 'CreateAccessWarrant' => [
- 'summary' => '阿里云控制台/授权凭证创建。',
- 'path' => '/api/v1/aliyunConsole/createAccessWarrant',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'AITeacherExpansionPracticeTaskGenerate' => [
+ 'summary' => '拓展练问答对生成。',
+ 'path' => '/api/v1/aiteacher/expansionPractice/generateTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '259954',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
- ],
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '258684',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
],
'parameters' => [
[
@@ -934,52 +977,38 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => 'WarrantCreateCmd',
- 'description' => 'WarrantCreateCmd',
+ 'description' => '请求body参数。',
'type' => 'object',
'properties' => [
- 'appId' => [
- 'title' => '商户分配的项目的appkey',
- 'description' => '商户分配的项目的appkey',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'a123',
- ],
- 'timestamp' => [
- 'title' => '商户发起授权请求时的时间戳(以秒为单位的10位时间戳)',
- 'description' => '商户发起授权请求时的时间戳(以秒为单位的10位时间戳)',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1701000000',
- ],
- 'userId' => [
- 'title' => '商户用户ID',
- 'description' => '商户用户ID',
+ 'userId' => ['description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '6440xxxxxxxxxx5fafc98c421'],
+ 'grade' => [
+ 'description' => '年级',
'type' => 'string',
- 'required' => false,
- 'example' => 'sn123',
+ 'required' => true,
+ 'enumValueTitles' => [3 => '小学3年级', '小学4年级', '小学5年级', '小学6年级', '中学7年级', '中学8年级', '中学9年级', '中学10年级', '中学11年级', '中学12年级', '大学'],
+ 'example' => '13',
],
- 'userClientIp' => [
- 'title' => '客户端设备公网IP',
- 'description' => '客户端设备公网IP',
+ 'textbook' => ['description' => '教材名称', 'type' => 'string', 'required' => false, 'example' => '英语(基础模块)修订版'],
+ 'topic' => ['description' => '对话主题', 'type' => 'string', 'required' => true, 'example' => 'talk about your dream job.'],
+ 'learningObject' => ['description' => '学习目标', 'type' => 'string', 'required' => false, 'example' => 'Understanding unique professions such as dog walkers, hotel test sleepers, and food tasters, including their job responsibilities and the benefits or challenges associated with each role.'],
+ 'textContent' => [
+ 'description' => '用于生成问题的参考文章',
'type' => 'string',
- 'required' => false,
- 'example' => '110.25.23.12',
+ 'required' => true,
+ 'enumValueTitles' => [],
+ 'example' => 'Dog walker Dog walking, as a profession, originated in the US. Some may think that it\'s a perfect job, because dog walkers won\'t be imprisoned in an office. But it\'s actually manual labour. At their busiest, dog walkers may have more than ten dogs to take care of in a day. Hotel test sleeper A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining and other services of hotels, in order to provide evaluations and guides for travelers. Hotel test sleepers don\'t need to punch in for work and they get about ten thousand yuan as income every month. What a comfortable job! Food taster In ancient times, a food taster was a person who tasted foods (or drinks) to be served to someone else, to confirm that it was safe to eat. But now, those working as food tasters just get to taste various new foods and drinks aimed at specific regions across the world. They then give their opinions on these products to the companies and suggest improvements.',
],
- 'requestSign' => [
- 'title' => '授权接口参数签名',
- 'description' => '授权接口参数签名',
- 'type' => 'string',
+ 'keySentences' => [
+ 'description' => '重点学习句子集合',
+ 'type' => 'array',
+ 'items' => ['description' => '重点学习句子', 'type' => 'string', 'required' => false, 'example' => 'A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining, and other services of hotels.'],
'required' => false,
- 'example' => 'e32fac43df0b0b0be32fac43df0b0b0b',
],
- 'warrantAvailable' => [
- 'title' => '授权ID有效期,单位:秒',
- 'description' => '授权ID有效期,单位:秒',
- 'type' => 'integer',
- 'format' => 'int32',
+ 'keyWords' => [
+ 'description' => '重点学习单词集合',
+ 'type' => 'array',
+ 'items' => ['description' => '重点学习单词', 'type' => 'string', 'required' => false, 'example' => 'responsibility'],
'required' => false,
- 'example' => '7200',
],
],
'required' => false,
@@ -989,680 +1018,696 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'SingleResponse<AccessWarrantDTO>',
- 'description' => 'SingleResponse<AccessWarrantDTO>',
+ 'title' => 'Schema of Response',
+ 'description' => '响应结构体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'ApplicationAccessId' => [
- 'title' => '应用识别码 appKey',
- 'description' => '应用识别码 appKey',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'UserId' => [
- 'title' => '用户id',
- 'description' => '用户id',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'AccessToken' => [
- 'title' => '访问凭证',
- 'description' => '访问凭证',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'AccessWarrantId' => [
- 'title' => '访问凭证',
- 'description' => '访问凭证',
- 'type' => 'string',
- 'example' => 'ex2xxxxxxxx',
- ],
- 'ExpireTime' => [
- 'title' => '凭证有效期',
- 'description' => '凭证有效期',
- 'type' => 'string',
- 'example' => '1672531200',
+ 'taskType' => ['description' => '任务类型', 'type' => 'string', 'example' => 'textbook_dialogue'],
+ 'taskContent' => [
+ 'description' => '问答对集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '问答对',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['description' => 'AI老师提问', 'type' => 'string', 'example' => 'Why might some people think dog walking is a great job?'],
+ 'user' => ['description' => '学生回答', 'type' => 'string', 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ ],
+ ],
],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '1672531200',
+ 'backgroundDescription' => ['description' => '对话背景描述', 'type' => 'string', 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.'],
+ 'startSentence' => ['description' => '起始句子', 'type' => 'string', 'example' => 'Hey Jamie, do you know what a travel blogger does?'],
+ 'roleSet' => [
+ 'description' => '角色设置',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['description' => 'AI老师扮演者', 'type' => 'string', 'example' => 'Alex'],
+ 'user' => ['description' => '学生扮演者', 'type' => 'string', 'example' => 'Jamie'],
+ ],
],
],
- 'example' => '[]',
],
],
- 'example' => '{'."\n"
- .' "success": true,'."\n"
- .' "data":{'."\n"
- .' "appId": "a123",'."\n"
- .' "userId": "u456",'."\n"
- .' "accessToken": "abc123def456ghi789jkl012mno345pqr678stu901vwx2yz345fgh67i",'."\n"
- .' "warrantId": "warrant_123456",'."\n"
- .' "expireTime": "2024-01-01T12:00:00Z"'."\n"
- .' },'."\n"
- .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
- .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ApplicationAccessId\\": \\"1234567890\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"AccessToken\\": \\"1234567890\\",\\n \\"AccessWarrantId\\": \\"ex2xxxxxxxx\\",\\n \\"ExpireTime\\": \\"1672531200\\",\\n \\"CreateTime\\": \\"1672531200\\"\\n }\\n}","type":"json"}]',
- 'title' => '创建授权信息',
- ],
- 'QueryApplicationAccessId' => [
- 'summary' => '阿里云控制台/获取应用访问识别码(appkey)信息。',
- 'path' => '/api/v1/aliyunConsole/queryApplicationAccessId',
- 'methods' => [
- 'get',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskType\\": \\"textbook_dialogue\\",\\n \\"taskContent\\": [\\n {\\n \\"assistant\\": \\"Why might some people think dog walking is a great job?\\",\\n \\"user\\": \\"They think it\'s great because they won\'t be stuck in an office.\\"\\n }\\n ],\\n \\"backgroundDescription\\": \\"In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.\\",\\n \\"startSentence\\": \\"Hey Jamie, do you know what a travel blogger does?\\",\\n \\"roleSet\\": {\\n \\"assistant\\": \\"Alex\\",\\n \\"user\\": \\"Jamie\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '拓展练对话任务生成',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExpansionPracticeTaskGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'AITeacherSyncPracticeTaskGenerate' => [
+ 'summary' => '同步基础练主要面向有标准答案的对话任务,虽然该模式允许用户和标准答案有一定的区别或偏差,但AI会相对严格的要求用户使用标准答案回复问题,',
+ 'path' => '/api/v1/aiteacher/syncPractice/generateTask',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'readAndWrite',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '258598',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'applicationAccessId',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '应用识别码、appkey',
- 'description' => '应用访问识别码(appkey)',
- 'type' => 'string',
+ 'description' => '请求body参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'userId' => ['description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '6440xxxxxxxxxx5fafc98c421'."\n"],
+ 'grade' => [
+ 'description' => '年级',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => [3 => '3年级', '4年级', '5年级', '6年级', '7年级', '8年级', '9年级', '10年级', '11年级', '12年级', '大学'],
+ 'example' => '13'."\n",
+ ],
+ 'textbook' => ['description' => '教材名', 'type' => 'string', 'required' => false, 'example' => '英语(基础模块)修订版'."\n"],
+ 'topic' => ['description' => '对话主题', 'type' => 'string', 'required' => true, 'example' => 'talk about your dream job.'."\n"],
+ 'learningObject' => ['description' => '学习目标', 'type' => 'string', 'required' => false, 'example' => 'Understanding unique professions such as dog walkers, hotel test sleepers, and food tasters, including their job responsibilities and the benefits or challenges associated with each role.'."\n"],
+ 'textContent' => ['description' => '用于生成问题的参考文章', 'type' => 'string', 'required' => true, 'example' => 'Dog walker Dog walking, as a profession, originated in the US. Some may think that it\'s a perfect job, because dog walkers won\'t be imprisoned in an office. But it\'s actually manual labour. At their busiest, dog walkers may have more than ten dogs to take care of in a day. Hotel test sleeper A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining and other services of hotels, in order to provide evaluations and guides for travelers. Hotel test sleepers don\'t need to punch in for work and they get about ten thousand yuan as income every month. What a comfortable job! Food taster In ancient times, a food taster was a person who tasted foods (or drinks) to be served to someone else, to confirm that it was safe to eat. But now, those working as food tasters just get to taste various new foods and drinks aimed at specific regions across the world. They then give their opinions on these products to the companies and suggest improvements.'],
+ 'keySentences' => [
+ 'description' => '重点学习句子集合',
+ 'type' => 'array',
+ 'items' => ['description' => '重点学习句子', 'type' => 'string', 'required' => false, 'example' => 'A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining, and other services of hotels.'],
+ 'required' => false,
+ ],
+ 'keyWords' => [
+ 'description' => '重点学习单词集合',
+ 'type' => 'array',
+ 'items' => ['description' => '重点学习单词', 'type' => 'string', 'required' => false, 'example' => 'responsibility'."\n"],
+ 'required' => false,
+ ],
+ ],
'required' => false,
- 'example' => '1234567890',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SingleResponse<ApplicationAccessIdDTO>',
- 'description' => 'SingleResponse<ApplicationAccessIdDTO>',
+ 'title' => 'Schema of Response',
+ 'description' => '响应结构体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求Id', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'."\n"],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'."\n"],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'."\n"],
+ 'httpStatusCode' => ['description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'applicationAccessId' => [
- 'title' => '应用识别码、appkey',
- 'description' => '应用识别码、appkey',
- 'type' => 'string',
- 'example' => '1234567890',
+ 'taskType' => ['description' => '任务类型', 'type' => 'string', 'example' => 'textbook_question_answering'],
+ 'taskContent' => [
+ 'description' => '问答对集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '问答对',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['description' => 'AI老师提问', 'type' => 'string', 'example' => 'Why might some people think dog walking is a great job?'."\n"],
+ 'user' => ['description' => '学生回答', 'type' => 'string', 'example' => 'They think it\'s great because they won\'t be stuck in an office.'."\n"],
+ ],
+ ],
],
- 'applicationAccessSecret' => [
- 'title' => '应用秘钥,只有控制台请求才会返回',
- 'description' => '应用秘钥,只有控制台请求才会返回',
- 'type' => 'string',
- 'example' => 'MyAppSecret',
+ ],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\\\n\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\\\n\\",\\n \\"errMessage\\": \\"未知错误\\\\n\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskType\\": \\"textbook_question_answering\\",\\n \\"taskContent\\": [\\n {\\n \\"assistant\\": \\"Why might some people think dog walking is a great job?\\\\n\\",\\n \\"user\\": \\"They think it\'s great because they won\'t be stuck in an office.\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '同步练对话任务生成',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:SyncPracticeTasksGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList' => [
+ 'summary' => '阿里云控制台/列出阿里云控制台上可使用的服务列表。',
+ 'path' => '/api/v1/aliyunconsole/queryAliyunConsoleServcieList',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
+ 'description' => '开放接口多数据结构体返回对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'ServiceCode' => ['title' => '服务编码', 'description' => '服务编码', 'type' => 'string', 'example' => 'online_ai_algorithm_personalized_text_to_image_call_count'],
+ 'ServiceName' => ['title' => '服务名称', 'description' => '服务名称', 'type' => 'string', 'example' => 'AI算法模型-个性化文生图-在线按量调用'],
+ 'FreeCount' => ['title' => '体验调用量', 'description' => '体验调用量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'FreeConcurrencyCount' => ['title' => '体验并发数', 'description' => '体验并发数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
+ 'description' => '',
],
'example' => '[]',
],
],
'example' => '{'."\n"
- .' "success": true,'."\n"
- .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .' "data":['."\n"
+ .' {'."\n"
+ .' "freeConcurrencyCount":1,'."\n"
+ .' "serviceCode":"online_oral_evaluation_call_count",'."\n"
+ .' "serviceName":"口语评测-在线预付费按量调用",'."\n"
+ .' "freeCount":500'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "freeConcurrencyCount":1,'."\n"
+ .' "serviceCode":"online_ai_algorithm_conversation_call_count",'."\n"
+ .' "serviceName":"AI算法模型-人机对话-在线按量调用",'."\n"
+ .' "freeCount":500'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "success":true,'."\n"
+ .' "requestId":"592A27EF-26D3-1434-98C1-97AD63337852",'."\n"
+ .' "notEmpty":true,'."\n"
+ .' "empty":false'."\n"
.'}',
],
],
],
'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"ServiceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"ServiceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"FreeCount\\": 100,\\n \\"FreeConcurrencyCount\\": 10\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '开放的服务能力列表',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServcieList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询应用访问编号',
],
- 'QueryProjectList' => [
- 'summary' => '阿里云控制台/获取项目列表',
- 'path' => '/api/v1/aliyunConsole/queryProjectList',
- 'methods' => [
- 'get',
+ 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList' => [
+ 'summary' => '阿里云控制台/列出阿里云控制台上可使用的服务列表。',
+ 'path' => '/api/v1/aliyunConsole/queryAliyunConsoleServiceList',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
+ 'description' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'array',
+ 'items' => ['description' => '数据对象', '$ref' => '#/components/schemas/AliyunConsoleServiceInfoDTO'],
+ 'example' => '[]',
+ ],
+ ],
+ 'example' => '{'."\n"
+ .' "data":['."\n"
+ .' {'."\n"
+ .' "freeConcurrencyCount":1,'."\n"
+ .' "serviceCode":"online_oral_evaluation_call_count",'."\n"
+ .' "serviceName":"口语评测-在线预付费按量调用",'."\n"
+ .' "freeCount":500'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "freeConcurrencyCount":1,'."\n"
+ .' "serviceCode":"online_ai_algorithm_conversation_call_count",'."\n"
+ .' "serviceName":"AI算法模型-人机对话-在线按量调用",'."\n"
+ .' "freeCount":500'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "success":true,'."\n"
+ .' "requestId":"592A27EF-26D3-1434-98C1-97AD63337852",'."\n"
+ .' "notEmpty":true,'."\n"
+ .' "empty":false'."\n"
+ .'}',
+ ],
+ ],
],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"serviceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"serviceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"freeCount\\": 100,\\n \\"freeConcurrencyCount\\": 10,\\n \\"documentUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\",\\n \\"buyUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '服务列表查询',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServiceList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'AliyunConsoleOpenApiQueryPaidResource' => [
+ 'summary' => '阿里云控制台/列出购买过的资源列表',
+ 'path' => '/api/v1/aliyunConsole/queryPaidResource',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '259876',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => 'nextToken', 'description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => 'maxResults', 'description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'resourceType',
+ 'in' => 'query',
+ 'schema' => ['title' => 'resourceType', 'description' => 'resourceType', 'type' => 'string', 'required' => false, 'example' => 'ALL'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => 'pageSize', 'description' => 'pageSize', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => 'pageIndex', 'description' => 'pageIndex', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => 'orderBy', 'description' => 'orderBy', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => 'orderDirection', 'description' => 'orderDirection', 'type' => 'string', 'required' => false, 'example' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => 'groupBy', 'description' => 'groupBy', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => 'needTotalCount', 'description' => 'needTotalCount', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
],
- 'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiMultiResponse<ProjectDTO>',
- 'description' => 'OpenApiMultiResponse<ProjectDTO>',
+ 'title' => 'OpenApiPageResponse<PaidResourceDTO>',
+ 'description' => 'OpenApiPageResponse<PaidResourceDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'totalCount' => ['title' => '总数量', 'description' => '总数量', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'pageSize' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'pageIndex' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'nextToken' => ['title' => 'nextToken', 'description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ 'skip' => ['title' => 'skip', 'description' => 'skip', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'maxResults' => ['title' => 'maxResults', 'description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ProjectId' => [
- 'title' => '项目ID',
- 'description' => '项目ID',
- 'type' => 'string',
- 'example' => '4910',
- ],
- 'ProjectName' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'example' => 'MyProject',
- ],
- 'ProjectType' => [
- 'title' => '项目类型',
- 'description' => '项目类型',
- 'type' => 'string',
- 'example' => 'WebApplication',
- ],
- 'ProjectApps' => [
- 'title' => '项目应用列表',
- 'description' => '项目应用列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '应用结构体',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'example' => '4700',
- ],
- 'ApplicationAccessIds' => [
- 'title' => '应用访问凭证',
- 'description' => '应用访问凭证',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'applicationAccessId' => [
- 'title' => '应用识别码、appkey',
- 'description' => '应用识别码、appkey',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'applicationAccessSecret' => [
- 'title' => '应用秘钥,只有控制台请求才会返回',
- 'description' => '应用秘钥,只有控制台请求才会返回',
- 'type' => 'string',
- 'example' => 'MyAppSecret',
- ],
- ],
- ],
- ],
- 'ProjectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '4747',
- ],
- ],
- ],
- ],
- 'ProjectSDK' => [
- 'title' => '项目SDK',
- 'description' => '项目SDK',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SdkName' => [
- 'title' => 'SDK名称',
- 'description' => 'SDK名称',
- 'type' => 'string',
- 'example' => 'GO AUTH',
- ],
- 'DeployMode' => [
- 'title' => '部署模式:客户端或者服务端',
- 'description' => '部署模式:客户端或者服务端',
- 'type' => 'string',
- 'example' => '服务端',
- ],
- 'DevelopLanguage' => [
- 'title' => '开发语言',
- 'description' => '开发语言',
- 'type' => 'string',
- 'example' => 'JAVA',
- ],
- 'SdkUrl' => [
- 'title' => 'SDK地址',
- 'description' => 'SDK地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/sdk.zip',
- ],
- 'DocUrl' => [
- 'title' => '文档地址',
- 'description' => '文档地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/doc',
- ],
- 'DemoUrl' => [
- 'title' => 'demo地址',
- 'description' => 'demo地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/demo',
- ],
- 'SdkVersion' => [
- 'title' => 'SDK版本',
- 'description' => 'SDK版本',
- 'type' => 'string',
- 'example' => '.3.52',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-07-16T08:23:19Z',
- ],
- ],
- ],
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2025-02-18 12:10:22',
- ],
- ],
- ],
+ 'items' => ['description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/PaidResourceDTO'],
'example' => '[]',
],
],
- 'example' => '{'."\n"
- .' "success": true,'."\n"
- .' “data":[{'."\n"
- .' "appId": "a123",'."\n"
- .' "deviceType": "iOS",'."\n"
- .' "deployType": "server",'."\n"
- .' "devLanguage": "java",'."\n"
- .' "sdkVersion": "1.0.0",'."\n"
- .' "sdkUrl": "http://www.xxx.com/abc.tgz",'."\n"
- .' "sdkMd5": "1234567890",'."\n"
- .' "sdkName": "XXAppIdServerSDK2024"'."\n"
- .' }],'."\n"
- .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
- .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"ProjectId\\": \\"4910\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"4700\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"4747\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"GO AUTH\\",\\n \\"DeployMode\\": \\"服务端\\",\\n \\"DevelopLanguage\\": \\"JAVA\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\".3.52\\",\\n \\"CreateTime\\": \\"2024-07-16T08:23:19Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2025-02-18 12:10:22\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询项目列表',
- ],
- 'QueryProject' => [
- 'summary' => '阿里云控制台/获取项目列表',
- 'path' => '/api/v1/aliyunConsole/queryProject',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"pageSize\\": 10,\\n \\"pageIndex\\": 1,\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"skip\\": 10,\\n \\"maxResults\\": 10,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"\\",\\n \\"resourcePackageCode\\": \\"PRE_PAID_RECOURSE_PACKAGE\\",\\n \\"resourcePackageName\\": \\"智能批改-资源包\\",\\n \\"resourceCatalogCode\\": \\"AI_ORAL\\",\\n \\"resourceCatalogName\\": \\"口语评测\\",\\n \\"resourceStatus\\": \\"\\",\\n \\"quantity\\": 0,\\n \\"remainQuantity\\": 0,\\n \\"effectiveTime\\": \\"\\",\\n \\"expireTime\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '已购买资源列表',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:AliyunConsoleOpenApiQueryPaidResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CountOralEvaluationStatisticsCalls' => [
+ 'summary' => '智能批改/口语评测/统计/调用量',
+ 'path' => '/api/v1/aliyunConsole/countOralEvaluationStatisticsCalls',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '260346',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
- 'name' => 'projectId',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => '请求体参数', 'required' => false, '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountRequest'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
+ 'title' => 'OpenApiMultiResponse<OralEvaluationStatisticsCallsCountResponseDTO>',
+ 'description' => 'OpenApiMultiResponse<OralEvaluationStatisticsCallsCountResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据对象', '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountResponse'],
+ 'example' => '[]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"123\\",\\n \\"projectData\\": {\\n \\"applicationInternalId\\": \\"11\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"a0007g7\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"2025-01\\",\\n \\"count\\": 2\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '口语评测服务调用量查询',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:countOralEvaluationStatisticsCalls',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
+ ],
+ 'CountOralEvaluationStatisticsConcurrent' => [
+ 'summary' => '智能批改/口语评测/统计/并发数',
+ 'path' => '/api/v1/aliyunConsole/countOralEvaluationStatisticsConcurrent',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '260347',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => '请求体对象。', 'required' => false, '$ref' => '#/components/schemas/OralEvaluationStatisticsConcurrentCountRequest'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'SingleResponse<ProjectDTO>',
- 'description' => 'SingleResponse<ProjectDTO>',
+ 'title' => 'OpenApiMultiResponse<OralEvaluationStatisticsConcurrentCountResponseDTO>',
+ 'description' => 'OpenApiMultiResponse<OralEvaluationStatisticsConcurrentCountResponseDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据对象', '$ref' => '#/components/schemas/OralEvaluationStatisticsConcurrentCountResponse'],
+ 'example' => '[]',
],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"123\\",\\n \\"projectData\\": {\\n \\"applicationInternalId\\": \\"11\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"a0007g7\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"2025-01\\",\\n \\"count\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '口语评测服务并发数统计',
+ 'changeSet' => [],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:countOralEvaluationStatisticsConcurrent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'CountOralEvaluationStatisticsError' => [
+ 'summary' => '智能批改/口语评测/统计/调用错误',
+ 'path' => '/api/v1/aliyunConsole/countOralEvaluationStatisticsError',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'list'],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => ['description' => '口语评测服务错误码统计请求体对象', 'required' => false, '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountRequest'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiMultiResponse<OralEvaluationStatisticsErrorCountResponseDTO>',
+ 'description' => 'OpenApiMultiResponse<OralEvaluationStatisticsErrorCountResponseDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'ProjectId' => [
- 'title' => '项目ID',
- 'description' => '项目ID',
- 'type' => 'string',
- 'example' => '67055',
- ],
- 'ProjectName' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'example' => 'MyProject',
- ],
- 'ProjectType' => [
- 'title' => '项目类型',
- 'description' => '项目类型',
- 'type' => 'string',
- 'example' => 'WebApplication',
- ],
- 'ProjectApps' => [
- 'title' => '项目应用列表',
- 'description' => '项目应用列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '项目应用',
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'example' => '2144',
- ],
- 'ApplicationAccessIds' => [
- 'title' => '应用访问凭证',
- 'description' => '应用访问凭证',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'applicationAccessId' => [
- 'title' => '应用识别码、appkey',
- 'description' => '应用识别码、appkey',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'applicationAccessSecret' => [
- 'title' => '应用秘钥,只有控制台请求才会返回',
- 'description' => '应用秘钥,只有控制台请求才会返回',
- 'type' => 'string',
- 'example' => 'MyAppSecret',
- ],
- ],
- ],
- ],
- 'ProjectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '159',
- ],
- ],
- ],
- ],
- 'ProjectSDK' => [
- 'title' => '项目SDK',
- 'description' => '项目SDK',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SdkName' => [
- 'title' => 'SDK名称',
- 'description' => 'SDK名称',
- 'type' => 'string',
- 'example' => 'JSSDK',
- ],
- 'DeployMode' => [
- 'title' => '部署模式:客户端或者服务端',
- 'description' => '部署模式:客户端或者服务端',
- 'type' => 'string',
- 'example' => '服务端',
- ],
- 'DevelopLanguage' => [
- 'title' => '开发语言',
- 'description' => '开发语言',
- 'type' => 'string',
- 'example' => 'JAVA',
- ],
- 'SdkUrl' => [
- 'title' => 'SDK地址',
- 'description' => 'SDK地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/sdk.zip',
- ],
- 'DocUrl' => [
- 'title' => '文档地址',
- 'description' => '文档地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/doc',
- ],
- 'DemoUrl' => [
- 'title' => 'demo地址',
- 'description' => 'demo地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/demo',
- ],
- 'SdkVersion' => [
- 'title' => 'SDK版本',
- 'description' => 'SDK版本',
- 'type' => 'string',
- 'example' => '5.1.0',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-01T13:40:53Z',
- ],
- ],
- ],
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-01T13:40:53Z',
- ],
- ],
+ 'type' => 'array',
+ 'items' => ['description' => '口语评测服务错误码响应体对象', '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountResponse'],
'example' => '[]',
],
],
- 'example' => '{'."\n"
- .' "success": true,'."\n"
- .' “data":{'."\n"
- .' "appId": "a123",'."\n"
- .' "deviceType": "iOS",'."\n"
- .' "deployType": "server",'."\n"
- .' "devLanguage": "java",'."\n"
- .' "sdkVersion": "1.0.0",'."\n"
- .' "sdkUrl": "http://www.xxx.com/abc.tgz",'."\n"
- .' "sdkMd5": "1234567890",'."\n"
- .' "sdkName": "XXAppIdServerSDK2024"'."\n"
- .' },'."\n"
- .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
- .'}',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ProjectId\\": \\"67055\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"2144\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"159\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"JSSDK\\",\\n \\"DeployMode\\": \\"服务端\\",\\n \\"DevelopLanguage\\": \\"JAVA\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\"5.1.0\\",\\n \\"CreateTime\\": \\"2024-11-01T13:40:53Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-11-01T13:40:53Z\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询项目信息',
- ],
- 'CreateProject' => [
- 'summary' => '阿里云控制台/创建项目',
- 'path' => '/api/v1/aliyunConsole/createProject',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"123\\",\\n \\"ProjectData\\": {\\n \\"applicationInternalId\\": \\"1\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"t000797\\",\\n \\"Data\\": [\\n {\\n \\"ErrorCode\\": \\"51000\\",\\n \\"ErrorMessage\\": \\"start the core unsuccessfull.\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"2025-02\\",\\n \\"count\\": 230\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '口语评测服务错误码统计',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:countOralEvaluationStatisticsError',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateAccessWarrant' => [
+ 'summary' => '阿里云控制台/授权凭证创建。',
+ 'path' => '/api/v1/aliyunConsole/createAccessWarrant',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1671,11 +1716,8 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '259770',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '259954',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
],
'parameters' => [
[
@@ -1683,24 +1725,16 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => 'ProjectCreateCmd',
- 'description' => 'ProjectCreateCmd',
+ 'title' => 'WarrantCreateCmd',
+ 'description' => 'WarrantCreateCmd',
'type' => 'object',
'properties' => [
- 'projectName' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MyProject',
- ],
- 'projectType' => [
- 'title' => '项目类型',
- 'description' => '项目类型',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'online_oral_evaluation_post_paid_call_count',
- ],
+ 'appId' => ['title' => '商户分配的项目的appkey', 'description' => '商户分配的项目的appkey', 'type' => 'string', 'required' => false, 'example' => 'a123'],
+ 'timestamp' => ['title' => '商户发起授权请求时的时间戳(以秒为单位的10位时间戳)', 'description' => '商户发起授权请求时的时间戳(以秒为单位的10位时间戳)', 'type' => 'string', 'required' => false, 'example' => '1701000000'],
+ 'userId' => ['title' => '商户用户ID', 'description' => '商户用户ID', 'type' => 'string', 'required' => false, 'example' => 'sn123'],
+ 'userClientIp' => ['title' => '客户端设备公网IP', 'description' => '客户端设备公网IP', 'type' => 'string', 'required' => false, 'example' => '110.25.23.12'],
+ 'requestSign' => ['title' => '授权接口参数签名', 'description' => '授权接口参数签名', 'type' => 'string', 'required' => false, 'example' => 'e32fac43df0b0b0be32fac43df0b0b0b'],
+ 'warrantAvailable' => ['title' => '授权ID有效期,单位:秒', 'description' => '授权ID有效期,单位:秒', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7200'],
],
'required' => false,
],
@@ -1709,173 +1743,26 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'SingleResponse<Boolean>',
- 'description' => 'SingleResponse<Boolean>',
+ 'title' => 'SingleResponse<AccessWarrantDTO>',
+ 'description' => 'SingleResponse<AccessWarrantDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'ProjectId' => [
- 'title' => '项目ID',
- 'description' => '项目ID',
- 'type' => 'string',
- 'example' => '124187',
- ],
- 'ProjectName' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'example' => 'MyProject',
- ],
- 'ProjectType' => [
- 'title' => '项目类型',
- 'description' => '项目类型',
- 'type' => 'string',
- 'example' => 'WebApplication',
- ],
- 'ProjectApps' => [
- 'title' => '项目应用列表',
- 'description' => '项目应用列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'Id' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'example' => '4867',
- ],
- 'ApplicationAccessIds' => [
- 'title' => '应用访问凭证',
- 'description' => '应用访问凭证',
- 'type' => 'array',
- 'items' => [
- 'description' => '访问识别码(appkey)结构体',
- 'type' => 'object',
- 'properties' => [
- 'applicationAccessId' => [
- 'title' => '应用识别码、appkey',
- 'description' => '应用识别码、appkey',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'applicationAccessSecret' => [
- 'title' => '应用秘钥,只有控制台请求才会返回',
- 'description' => '应用秘钥,只有控制台请求才会返回',
- 'type' => 'string',
- 'example' => 'MyAppSecret',
- ],
- ],
- ],
- ],
- 'ProjectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '4910',
- ],
- ],
- ],
- ],
- 'ProjectSDK' => [
- 'title' => '项目SDK',
- 'description' => '项目SDK',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'SdkName' => [
- 'title' => 'SDK名称',
- 'description' => 'SDK名称',
- 'type' => 'string',
- 'example' => 'C SDK',
- ],
- 'DeployMode' => [
- 'title' => '部署模式:客户端或者服务端',
- 'description' => '部署模式:客户端或者服务端',
- 'type' => 'string',
- 'example' => '客户端',
- ],
- 'DevelopLanguage' => [
- 'title' => '开发语言',
- 'description' => '开发语言',
- 'type' => 'string',
- 'example' => 'C++',
- ],
- 'SdkUrl' => [
- 'title' => 'SDK地址',
- 'description' => 'SDK地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/sdk.zip',
- ],
- 'DocUrl' => [
- 'title' => '文档地址',
- 'description' => '文档地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/doc',
- ],
- 'DemoUrl' => [
- 'title' => 'demo地址',
- 'description' => 'demo地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/demo',
- ],
- 'SdkVersion' => [
- 'title' => 'SDK版本',
- 'description' => 'SDK版本',
- 'type' => 'string',
- 'example' => '4.12.8',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-02-15T09:17:39Z'."\n",
- ],
- ],
- ],
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2023-02-15T09:17:39Z',
- ],
+ 'ApplicationAccessId' => ['title' => '应用识别码 appKey', 'description' => '应用识别码 appKey', 'type' => 'string', 'example' => '1234567890'],
+ 'UserId' => ['title' => '用户id', 'description' => '用户id', 'type' => 'string', 'example' => '1234567890'],
+ 'AccessToken' => ['title' => '访问凭证', 'description' => '访问凭证', 'type' => 'string', 'example' => '1234567890'],
+ 'AccessWarrantId' => ['title' => '访问凭证', 'description' => '访问凭证', 'type' => 'string', 'example' => 'ex2xxxxxxxx'],
+ 'ExpireTime' => ['title' => '凭证有效期', 'description' => '凭证有效期', 'type' => 'string', 'example' => '1672531200'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '1672531200'],
],
'example' => '[]',
],
@@ -1883,28 +1770,42 @@
'example' => '{'."\n"
.' "success": true,'."\n"
.' "data":{'."\n"
- .' "projectId": "proj_123456",'."\n"
- .' "projectAppIds": ["app_001", "app_002"],'."\n"
- .' "createTime": "2023-10-01T10:00:00Z",'."\n"
- .' "updateTime": "2023-10-02T11:00:00Z"'."\n"
- .' },'."\n"
+ .' "appId": "a123",'."\n"
+ .' "userId": "u456",'."\n"
+ .' "accessToken": "abc123def456ghi789jkl012mno345pqr678stu901vwx2yz345fgh67i",'."\n"
+ .' "warrantId": "warrant_123456",'."\n"
+ .' "expireTime": "2024-01-01T12:00:00Z"'."\n"
+ .' },'."\n"
.' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
.'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ProjectId\\": \\"124187\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"4867\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"4910\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"C SDK\\",\\n \\"DeployMode\\": \\"客户端\\",\\n \\"DevelopLanguage\\": \\"C++\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\"4.12.8\\",\\n \\"CreateTime\\": \\"2023-02-15T09:17:39Z\\\\n\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-02-15T09:17:39Z\\"\\n }\\n}","type":"json"}]',
- 'title' => '创建项目',
- ],
- 'UpdateProject' => [
- 'summary' => '阿里云控制台/更新项目信息',
- 'path' => '/api/v1/aliyunConsole/updateProject',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ApplicationAccessId\\": \\"1234567890\\",\\n \\"UserId\\": \\"1234567890\\",\\n \\"AccessToken\\": \\"1234567890\\",\\n \\"AccessWarrantId\\": \\"ex2xxxxxxxx\\",\\n \\"ExpireTime\\": \\"1672531200\\",\\n \\"CreateTime\\": \\"1672531200\\"\\n }\\n}","type":"json"}]',
+ 'title' => '创建授权信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:CreateAccessWarrant',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'CreateProject' => [
+ 'summary' => '阿里云控制台/创建项目',
+ 'path' => '/api/v1/aliyunConsole/createProject',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -1912,11 +1813,9 @@
],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'update',
- 'abilityTreeCode' => '259771',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '259770',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -1925,24 +1824,12 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'title' => 'ProjectUpdateCmd',
- 'description' => 'ProjectUpdateCmd',
+ 'title' => 'ProjectCreateCmd',
+ 'description' => 'ProjectCreateCmd',
'type' => 'object',
'properties' => [
- 'projectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'required' => false,
- 'example' => '123',
- ],
- 'projectName' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'MyProject',
- ],
+ 'projectName' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => false, 'example' => 'MyProject'],
+ 'projectType' => ['title' => '项目类型', 'description' => '项目类型', 'type' => 'string', 'required' => false, 'example' => 'online_oral_evaluation_post_paid_call_count'],
],
'required' => false,
],
@@ -1955,103 +1842,43 @@
'description' => 'SingleResponse<Boolean>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'ProjectId' => [
- 'title' => '项目ID',
- 'description' => '项目ID',
- 'type' => 'string',
- 'example' => '56160',
- ],
- 'ProjectName' => [
- 'title' => '项目名称',
- 'description' => '项目名称',
- 'type' => 'string',
- 'example' => 'MyProject',
- ],
- 'ProjectType' => [
- 'title' => '项目类型',
- 'description' => '项目类型',
- 'type' => 'string',
- 'example' => 'WebApplication',
- ],
+ 'ProjectId' => ['title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'example' => '124187'],
+ 'ProjectName' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'MyProject'],
+ 'ProjectType' => ['title' => '项目类型', 'description' => '项目类型', 'type' => 'string', 'example' => 'WebApplication'],
'ProjectApps' => [
'title' => '项目应用列表',
'description' => '项目应用列表',
'type' => 'array',
'items' => [
- 'description' => '应用结构体',
'type' => 'object',
'properties' => [
- 'Id' => [
- 'title' => '应用内部id',
- 'description' => '应用内部id',
- 'type' => 'string',
- 'example' => '4498',
- ],
+ 'Id' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'example' => '4867'],
'ApplicationAccessIds' => [
'title' => '应用访问凭证',
'description' => '应用访问凭证',
'type' => 'array',
'items' => [
+ 'description' => '访问识别码(appkey)结构体',
'type' => 'object',
'properties' => [
- 'applicationAccessId' => [
- 'title' => '应用识别码、appkey',
- 'description' => '应用识别码、appkey',
- 'type' => 'string',
- 'example' => '1234567890',
- ],
- 'applicationAccessSecret' => [
- 'title' => '应用秘钥,只有控制台请求才会返回',
- 'description' => '应用秘钥,只有控制台请求才会返回',
- 'type' => 'string',
- 'example' => 'MyAppSecret',
- ],
+ 'applicationAccessId' => ['title' => '应用识别码、appkey', 'description' => '应用识别码、appkey', 'type' => 'string', 'example' => '1234567890'],
+ 'applicationAccessSecret' => ['title' => '应用秘钥,只有控制台请求才会返回', 'description' => '应用秘钥,只有控制台请求才会返回', 'type' => 'string', 'example' => 'MyAppSecret'],
],
],
],
- 'ProjectId' => [
- 'title' => '项目id',
- 'description' => '项目id',
- 'type' => 'string',
- 'example' => '1889',
- ],
+ 'ProjectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '4910'],
],
+ 'description' => '',
],
],
'ProjectSDK' => [
@@ -2061,63 +1888,19 @@
'items' => [
'type' => 'object',
'properties' => [
- 'SdkName' => [
- 'title' => 'SDK名称',
- 'description' => 'SDK名称',
- 'type' => 'string',
- 'example' => 'PHP服务端SDK',
- ],
- 'DeployMode' => [
- 'title' => '部署模式:客户端或者服务端',
- 'description' => '部署模式:客户端或者服务端',
- 'type' => 'string',
- 'example' => '服务端',
- ],
- 'DevelopLanguage' => [
- 'title' => '开发语言',
- 'description' => '开发语言',
- 'type' => 'string',
- 'example' => 'PHP',
- ],
- 'SdkUrl' => [
- 'title' => 'SDK地址',
- 'description' => 'SDK地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/sdk.zip',
- ],
- 'DocUrl' => [
- 'title' => '文档地址',
- 'description' => '文档地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/doc',
- ],
- 'DemoUrl' => [
- 'title' => 'demo地址',
- 'description' => 'demo地址',
- 'type' => 'string',
- 'example' => 'http://demo.com/demo',
- ],
- 'SdkVersion' => [
- 'title' => 'SDK版本',
- 'description' => 'SDK版本',
- 'type' => 'string',
- 'example' => '4.13.0',
- ],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-11-01T13:40:53Z',
- ],
+ 'SdkName' => ['title' => 'SDK名称', 'description' => 'SDK名称', 'type' => 'string', 'example' => 'C SDK'],
+ 'DeployMode' => ['title' => '部署模式:客户端或者服务端', 'description' => '部署模式:客户端或者服务端', 'type' => 'string', 'example' => '客户端'],
+ 'DevelopLanguage' => ['title' => '开发语言', 'description' => '开发语言', 'type' => 'string', 'example' => 'C++'],
+ 'SdkUrl' => ['title' => 'SDK地址', 'description' => 'SDK地址', 'type' => 'string', 'example' => 'http://demo.com/sdk.zip'],
+ 'DocUrl' => ['title' => '文档地址', 'description' => '文档地址', 'type' => 'string', 'example' => 'http://demo.com/doc'],
+ 'DemoUrl' => ['title' => 'demo地址', 'description' => 'demo地址', 'type' => 'string', 'example' => 'http://demo.com/demo'],
+ 'SdkVersion' => ['title' => 'SDK版本', 'description' => 'SDK版本', 'type' => 'string', 'example' => '4.12.8'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-02-15T09:17:39Z'."\n"],
],
+ 'description' => '',
],
],
- 'CreateTime' => [
- 'title' => '创建时间',
- 'description' => '创建时间',
- 'type' => 'string',
- 'example' => '2024-12-10T02:07:16Z',
- ],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2023-02-15T09:17:39Z'],
],
'example' => '[]',
],
@@ -2135,102 +1918,31 @@
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ProjectId\\": \\"56160\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"4498\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"1889\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"PHP服务端SDK\\",\\n \\"DeployMode\\": \\"服务端\\",\\n \\"DevelopLanguage\\": \\"PHP\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\"4.13.0\\",\\n \\"CreateTime\\": \\"2024-11-01T13:40:53Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-10T02:07:16Z\\"\\n }\\n}","type":"json"}]',
- 'title' => '更新项目信息',
- ],
- 'QueryPurchasedService' => [
- 'summary' => '阿里云控制台/已经购买过的服务项目',
- 'path' => '/api/v1/aliyunConsole/queryPurchasedService',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ProjectId\\": \\"124187\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"4867\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"4910\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"C SDK\\",\\n \\"DeployMode\\": \\"客户端\\",\\n \\"DevelopLanguage\\": \\"C++\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\"4.12.8\\",\\n \\"CreateTime\\": \\"2023-02-15T09:17:39Z\\\\n\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-02-15T09:17:39Z\\"\\n }\\n}","type":"json"}]',
+ 'title' => '创建项目',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'security' => [
+ 'ramActions' => [
[
- 'AK' => [],
- ],
- ],
- 'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '264513',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
- ],
- 'tenantRelevance' => 'publicInformation',
- ],
- 'parameters' => [],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
- 'description' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
- 'type' => 'object',
- 'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '数据对象',
- 'description' => '数据对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '服务信息结构体',
- '$ref' => '#/components/schemas/AliyunConsoleServiceInfoDTO',
- ],
- 'example' => '[]',
- ],
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:CreateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'example' => '{'."\n"
- .' "success": true,'."\n"
- .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
- .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"serviceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"serviceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"freeCount\\": 100,\\n \\"freeConcurrencyCount\\": 10,\\n \\"documentUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\",\\n \\"buyUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '查询已购买的服务',
],
'ExecuteAITeacherChineseCompositionTutoringWorkflowRun' => [
'summary' => '中文作文辅导。',
'path' => '/pop/api/v1/intelligentAgent/chineseCompositionTutoring/workflowRun',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -2245,9 +1957,7 @@
'riskType' => 'none',
'chargeType' => 'paid',
'abilityTreeCode' => '264494',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -2259,30 +1969,12 @@
'description' => '请求body参数。',
'type' => 'object',
'properties' => [
- 'essayOutline' => [
- 'title' => '作文大纲',
- 'description' => '作文大纲',
- 'type' => 'string',
- 'required' => false,
- 'example' => '题目: 春天的色彩'."\n"
- .'开头: 开门见山,点明主题。'."\n"
- .'中间: 分段描写春天的不同色彩。'."\n"
- .'结尾: 总结全文,抒发情感。',
- ],
- 'essayRequirements' => [
- 'title' => '作文要求',
- 'description' => '作文要求(必填)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '生动形象,字数不得少于100字',
- ],
- 'essayTopic' => [
- 'title' => '作文主题',
- 'description' => '作文主题(必填)',
- 'type' => 'string',
- 'required' => true,
- 'example' => '春天的景色',
- ],
+ 'essayOutline' => ['title' => '作文大纲', 'description' => '作文大纲', 'type' => 'string', 'required' => false, 'example' => '题目: 春天的色彩'."\n"
+ .'开头: 开门见山,点明主题。'."\n"
+ .'中间: 分段描写春天的不同色彩。'."\n"
+ .'结尾: 总结全文,抒发情感。'],
+ 'essayRequirements' => ['title' => '作文要求', 'description' => '作文要求(必填)', 'type' => 'string', 'required' => true, 'example' => '生动形象,字数不得少于100字'],
+ 'essayTopic' => ['title' => '作文主题', 'description' => '作文主题(必填)', 'type' => 'string', 'required' => true, 'example' => '春天的景色'],
'essayType' => [
'title' => '作文类型',
'description' => '作文类型(必填)'."\n"
@@ -2293,44 +1985,19 @@
'type' => 'string',
'required' => true,
'example' => 'essay',
- 'enum' => [
- 'essay',
- 'outline',
- ],
- ],
- 'essayWordCount' => [
- 'title' => '要求字数',
- 'description' => '要求字数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'grade' => [
- 'title' => '年级',
- 'description' => '年级(必填)',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '3'."\n",
+ 'enum' => ['essay', 'outline'],
],
+ 'essayWordCount' => ['title' => '要求字数', 'description' => '要求字数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
+ 'grade' => ['title' => '年级', 'description' => '年级(必填)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3'."\n"],
'responseMode' => [
'title' => '数据响应方式',
'description' => '数据响应方式',
'type' => 'string',
'required' => true,
'example' => 'streaming',
- 'enum' => [
- 'streaming',
- ],
- ],
- 'userId' => [
- 'title' => '用户名',
- 'description' => '用户名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxxxxxx',
+ 'enum' => ['streaming'],
],
+ 'userId' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxxxx'],
],
'required' => false,
],
@@ -2343,22 +2010,9 @@
'description' => '响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID,请求错误时会返回对应内容',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'event' => [
- 'description' => '事件类型',
- 'type' => 'string',
- 'example' => 'message',
- ],
- 'content' => [
- 'description' => '事件对应的内容信息',
- 'type' => 'string',
- 'example' => '春天里常见的景',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID,请求错误时会返回对应内容', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'event' => ['description' => '事件类型', 'type' => 'string', 'example' => 'message'],
+ 'content' => ['description' => '事件对应的内容信息', 'type' => 'string', 'example' => '春天里常见的景'],
],
],
],
@@ -2366,19 +2020,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'errMsg' => [
- 'type' => 'string',
- ],
- 'errCode' => [
- 'type' => 'string',
- ],
- 'success' => [
- 'type' => 'string',
- ],
- 'httpStatusCode' => [
- 'type' => 'string',
- ],
+ 'errMsg' => ['type' => 'string', 'description' => ''],
+ 'errCode' => ['type' => 'string', 'description' => ''],
+ 'success' => ['type' => 'string', 'description' => ''],
+ 'httpStatusCode' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
],
@@ -2404,30 +2051,43 @@
.'data:{"event":"message","content":"的喜爱之情。"}'."\n"
."\n"
.'data:{"event":"end"}',
- ],
- 'GetTextbookAssistantToken' => [
- 'summary' => '获取请求调用授权码。',
- 'path' => '/api/v1/textbookAssistant/teachingResource/GetToken',
- 'methods' => [
- 'post',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-23T03:18:41.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherChineseCompositionTutoringWorkflowRun',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun' => [
+ 'summary' => '英语作文辅导',
+ 'path' => '/pop/api/v1/intelligentAgent/englishCompositionTutoring/workflowRun',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [],
- 'produces' => [],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '261955',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'abilityTreeCode' => '264493',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -2436,21 +2096,46 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体对象。',
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'deviceId' => [
- 'description' => '设备ID。',
+ 'essayOutline' => [
+ 'title' => '大纲',
+ 'description' => '作文大纲',
+ 'type' => 'string',
+ 'required' => false,
+ 'example' => 'Title: The Importance of Reading'."\n"
+ .'I. Introduction'."\n"
+ .'II. Body'."\n"
+ .'III. Conclusion',
+ 'enum' => [],
+ ],
+ 'essayRequirements' => ['title' => '要求', 'description' => '作文要求(必填)', 'type' => 'string', 'required' => true, 'example' => 'No less than 100 words'],
+ 'essayTopic' => ['title' => '主题', 'description' => '作文主题(必填)', 'type' => 'string', 'required' => true, 'example' => 'Discuss what to eat'],
+ 'essayType' => [
+ 'title' => '输出内容类型,essay:文章,outline:大纲',
+ 'description' => '作文类型(必填)'."\n"
+ ."\n"
+ .'outline:大纲'."\n"
+ ."\n"
+ .'essay:文章',
'type' => 'string',
'required' => true,
- 'example' => '700d4d9411efbe6e0',
+ 'example' => 'essay',
+ 'enum' => ['essay', 'outline'],
],
- 'model' => [
- 'description' => '设备型号。',
+ 'essayWordCount' => ['title' => '要求字数', 'description' => '要求字数', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100'],
+ 'grade' => ['title' => '年级', 'description' => '年级', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '3'],
+ 'responseMode' => [
+ 'title' => '数据响应方式',
+ 'description' => '数据响应方式',
'type' => 'string',
'required' => true,
- 'example' => '25032PS56C',
+ 'example' => 'streaming',
+ 'default' => 'streaming',
+ 'enum' => ['streaming'],
],
+ 'userId' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxx'],
],
'required' => false,
],
@@ -2460,141 +2145,68 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0A5E9849-A2F0-551D-A7D8-1A8118557BAB',
- ],
- 'success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**:成功'."\n"
- ."\n"
- .'- **false**:失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP 状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'description' => '返回数据对象。',
- 'type' => 'object',
- 'properties' => [
- 'expire' => [
- 'description' => '授权码有效期(秒)',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5400',
- ],
- 'authToken' => [
- 'description' => '授权码,用于调用英语教材式AI老师的其他接口。',
- 'type' => 'string',
- 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3',
- ],
- ],
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => '请求ID,请求错误时会返回对应内容', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'event' => ['description' => '事件', 'type' => 'string', 'example' => 'message'],
+ 'content' => ['description' => '事件对应的内容信息', 'type' => 'string', 'example' => 'hi'],
],
],
],
- 403 => [
+ 401 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
- 'accessDeniedDetail' => [
- 'type' => 'object',
- 'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
- ],
- ],
+ 'success' => ['type' => 'string', 'description' => ''],
+ 'errCode' => ['type' => 'string', 'description' => ''],
+ 'errMsg' => ['type' => 'string', 'description' => ''],
+ 'httpStatusCode' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"hi\\"\\n}","type":"json"}]',
+ 'title' => '英语作文生成',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-23T03:18:41.000Z', 'description' => '请求参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A5E9849-A2F0-551D-A7D8-1A8118557BAB\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"expire\\": 5400,\\n \\"authToken\\": \\"tc_197bf5bb81889cc79eb51ae9b8c0cea3\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取英语教材式AI老师功能使用授权码',
- ],
- 'ListTextbookAssistantGradeVolumes' => [
- 'summary' => '获取拥有英语教材资源的年级列表。',
- 'path' => '/api/v1/textbookAssistant/teachingResource/ListGradeVolumes',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherEnglishCompositionTutoringWorkflowRun',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteAITeacherEnglishParaphraseChatMessage' => [
+ 'summary' => '英语答疑',
+ 'path' => '/pop/api/v1/intelligentAgent/englishParaphrase/chatMessage',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
+ 'produces' => [],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'create',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '261927',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeCode' => '264496',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -2603,25 +2215,17 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体对象。',
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'scenario' => [
- 'description' => '使用场景。SYNC:同步练习,EXPAND:拓展练习',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3',
- ],
+ 'questionInfo' => ['title' => '题目信息', 'description' => '题目信息', 'type' => 'string', 'required' => true, 'example' => 'How to inquire about the price'],
+ 'grade' => ['title' => '年级信息', 'description' => '年级', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'],
+ 'userAnswer' => ['title' => '要求回答内容', 'description' => '问题的正确答案', 'type' => 'string', 'required' => true, 'example' => 'How much is this?'],
+ 'questionId' => ['title' => '题干ID', 'description' => '题目唯一标识', 'type' => 'string', 'required' => false, 'example' => 'xxxxxxxxx'],
+ 'content' => ['title' => '用户输入内容', 'description' => '用户输入内容', 'type' => 'string', 'required' => true, 'example' => 'How much is this?'],
+ 'chatId' => ['title' => '本次会话ID', 'description' => '本次会话ID', 'type' => 'string', 'required' => false, 'example' => '6788e0b475a4631ffc626722'],
+ 'userId' => ['title' => '用户名', 'description' => '用户名', 'type' => 'string', 'required' => true, 'example' => 'xxxxxxx'],
+ 'responseMode' => ['title' => '数据响应类型', 'description' => '数据响应方式', 'type' => 'string', 'required' => true, 'example' => 'sreaming'],
],
'required' => false,
],
@@ -2631,155 +2235,212 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'description' => '响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'F3B1AAF2-3041-5AA7-A352-BD5F998FA465',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '返回数据对象',
- 'description' => '返回数据对象',
+ 'event' => ['title' => 'Id of the request', 'description' => '事件', 'type' => 'string', 'example' => 'message'],
+ 'content' => ['description' => '事件对应的内容信息', 'type' => 'string', 'example' => 'how'],
+ 'requestId' => ['description' => '请求ID,请求错误时会返回对应内容', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ ],
+ ],
+ ],
+ 401 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'success' => ['type' => 'string', 'description' => ''],
+ 'errCode' => ['type' => 'string', 'description' => ''],
+ 'errMsg' => ['type' => 'string', 'description' => ''],
+ 'httpStatusCode' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"how\\",\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\"\\n}","type":"json"}]',
+ 'title' => '英语答疑',
+ 'changeSet' => [
+ ['createdAt' => '2025-04-23T03:18:41.000Z', 'description' => '请求参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherEnglishParaphraseChatMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ExecuteAITeacherExpansionDialogue' => [
+ 'summary' => '拓展练习对话主要针对较为开放的交流场景。在练习过程中,虽然AI提出的问题没有预设答案,但用户仍需在相关话题内进行回答。若用户回答偏离主题,AI会尝试引导其回归话题。如果用户连续两次跑题,AI将引导其继续下一个话题。',
+ 'path' => '/api/v1/aiteacher/expansionPractice/executeExpansionTraining',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '259932',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ 'tenantRelevance' => 'publicInformation',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录集合',
'type' => 'array',
'items' => [
+ 'description' => '对话记录结构体',
'type' => 'object',
'properties' => [
- 'textbookVersion' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => [
+ 'title' => '角色身份',
+ 'description' => '角色身份',
'type' => 'string',
- 'example' => '人教版',
- ],
- 'gradeVolumes' => [
- 'title' => '年级册次数据信息',
- 'description' => '年级册次数据信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'volume' => [
- 'title' => '册次,0:全一册,1:上册,2:下册',
- 'description' => '册次,0:全一册,1:上册,2:下册',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'grade' => [
- 'title' => '年级,取值范围 1-9,对应年级 level',
- 'description' => '年级,取值范围 1-9,对应年级 level',
- 'type' => 'string',
- 'example' => '3',
- ],
- ],
- ],
+ 'required' => true,
+ 'enumValueTitles' => ['assistant' => '老师', 'user' => '学生'],
+ 'example' => 'AI:assistant;用户:user',
],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用。'."\n"
+ .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
+ .'跑题超过两次,取值会强制置为true,用于强制切换任务。', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
+ ],
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
],
+ 'required' => true,
+ 'description' => '',
+ ],
+ 'required' => true,
+ ],
+ 'languageCode' => [
+ 'title' => '语言编码',
+ 'description' => '语言编码',
+ 'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['en-us' => '美式英语', 'en-gb' => '英式英语'],
+ 'example' => 'en-gb',
+ ],
+ 'background' => ['title' => '对话背景描述', 'description' => '对话背景描述', 'type' => 'string', 'required' => true, 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.'],
+ 'roleInfo' => [
+ 'title' => '角色设置',
+ 'description' => '角色设置',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师扮演者', 'description' => 'AI的名字', 'type' => 'string', 'required' => true, 'example' => 'Alex'],
+ 'user' => ['title' => '学生扮演者', 'description' => '用户的名字', 'type' => 'string', 'required' => true, 'example' => 'Jamie'],
],
+ 'required' => true,
],
+ 'topic' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'required' => true, 'example' => 'Let\'s talk about traffic rules.'],
+ 'startSentence' => ['title' => '开场语', 'description' => '开场语', 'type' => 'string', 'required' => false, 'example' => 'Hello Lily, could you please come to the kitchen for a moment?'],
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
],
+ 'required' => false,
],
],
- 403 => [
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
+ 'title' => 'OpenApiSingleResponse<AITeacherExpansionTrainDTO>',
+ 'description' => 'OpenApiSingleResponse<AITeacherExpansionTrainDTO>',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Sychro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
- 'accessDeniedDetail' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'englishResult' => ['title' => 'AI老师的英文回复', 'description' => 'AI老师的英文回复', 'type' => 'string', 'example' => '1'],
+ 'chineseResult' => ['title' => 'AI老师的中文回复', 'description' => 'AI老师的中文回复', 'type' => 'string', 'example' => '1'],
+ 'isFinish' => ['title' => '是否完成对话', 'description' => '是否完成对话', 'type' => 'boolean', 'example' => 'true'],
+ 'isOffTopicControl' => ['title' => '是否跑题', 'description' => '是否跑题', 'type' => 'boolean', 'example' => 'true'],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'example' => 'true'],
+ 'questionIndex' => ['title' => '当前作答的问题编号', 'description' => '当前作答的问题编号', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
+ 'example' => '[]',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F3B1AAF2-3041-5AA7-A352-BD5F998FA465\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"textbookVersion\\": \\"人教版\\",\\n \\"gradeVolumes\\": [\\n {\\n \\"volume\\": \\"1\\",\\n \\"grade\\": \\"3\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取拥有英语教材资源的年级列表',
- ],
- 'ListTextbookAssistantBooks' => [
- 'summary' => '获取包含年级下的书本列表。',
- 'path' => '/api/v1/textbookAssistant/teachingResource/ListBooks',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"1\\",\\n \\"chineseResult\\": \\"1\\",\\n \\"isFinish\\": true,\\n \\"isOffTopicControl\\": true,\\n \\"isOnTopic\\": true,\\n \\"questionIndex\\": 2\\n }\\n}","type":"json"}]',
+ 'title' => '执行拓展练',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:AITeacherExecuteExpansionPractice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteAITeacherExpansionDialogueRefine' => [
+ 'summary' => '拓展练根据上下文进行润色。',
+ 'path' => '/api/v1/aiteacher/expansionPractice/refineByContext',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '261982',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '259939',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
],
'parameters' => [
[
@@ -2787,51 +2448,75 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体对象。',
+ 'description' => '请求body参数。',
'type' => 'object',
'properties' => [
- 'bookId' => [
- 'description' => '书本编号ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '231698',
- ],
- 'grade' => [
- 'description' => '年级,取值范围1-9,和年级level对应',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1'."\n",
- ],
- 'volume' => [
- 'description' => '册次,0:全一册,1:上册,2:下册',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => [
+ 'title' => '角色身份',
+ 'description' => '角色身份',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['assistant' => '老师', 'user' => '学生'],
+ 'example' => 'AI:assistant;用户:user',
+ ],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用。'."\n"
+ .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
+ .'跑题超过两次,取值会强制置为true,用于强制切换任务。', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
],
- 'version' => [
- 'description' => '教材版本',
- 'type' => 'string',
- 'required' => false,
- 'example' => '人教版',
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
],
- 'page' => [
- 'description' => '页码',
- 'type' => 'string',
- 'required' => false,
- 'example' => '1',
+ 'background' => ['title' => '对话背景描述', 'description' => '对话背景描述', 'type' => 'string', 'required' => true, 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.'],
+ 'roleInfo' => [
+ 'title' => '角色设置',
+ 'description' => '角色设置',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '教师扮演角色', 'description' => 'AI的名字', 'type' => 'string', 'required' => true, 'example' => 'Jane, a caring mother'],
+ 'user' => ['title' => '学生扮演者', 'description' => '用户的名字', 'type' => 'string', 'required' => true, 'example' => 'Lily, a friendly student'],
+ ],
+ 'required' => true,
],
- 'maxResults' => [
- 'description' => '每页最大条目数,最大值20。',
+ 'topic' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'required' => true, 'example' => 'talk about your dream job.'],
+ 'languageCode' => [
+ 'title' => '语言编码',
+ 'description' => '语言编码',
'type' => 'string',
'required' => false,
- 'example' => '20',
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3',
+ 'enumValueTitles' => ['en-us' => '美式英语', 'en-gb' => '英式英语'],
+ 'example' => 'en-gb',
],
+ 'startSentence' => ['title' => '开场语', 'description' => '开场语', 'type' => 'string', 'required' => false, 'example' => 'Hello Lily, could you please come to the kitchen for a moment?'],
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
],
'required' => false,
],
@@ -2840,222 +2525,270 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'OpenApiSingleResponse<AITeacherOpenApiRefineDTO>',
+ 'description' => 'OpenApiSingleResponse<AITeacherOpenApiRefineDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'B695B377-7029-5805-9DE2-1AAE06C1BF6B',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'B_USER_NOT_FOUND_EXCEPTION',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '用户不存在',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '返回数据对象。',
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'paginationData' => [
- 'description' => '分页数据',
- 'type' => 'object',
- 'properties' => [
- 'totalCount' => [
- 'description' => '全量数据的条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'maxResults' => [
- 'description' => '本次查询单页的数据条数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '20',
- ],
- 'currentPage' => [
- 'description' => '当前页码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- ],
- ],
- 'bookList' => [
- 'description' => '书本列表信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'bookId' => [
- 'description' => '书本编号Id',
- 'type' => 'string',
- 'example' => '231698',
- ],
- 'isbn' => [
- 'description' => '国际标准书号',
- 'type' => 'string',
- 'example' => '9787107382505',
- ],
- 'edition' => [
- 'description' => '版次',
- 'type' => 'string',
- 'example' => '2024-7(1)',
- ],
- 'impression' => [
- 'description' => '印次',
- 'type' => 'string',
- 'example' => '2024-7(1)',
- ],
- 'publisher' => [
- 'description' => '出版社',
- 'type' => 'string',
- 'example' => '人民教育出版社',
- ],
- 'version' => [
- 'description' => '教材版本',
- 'type' => 'string',
- 'example' => '人教版',
- ],
- 'subject' => [
- 'description' => '学科',
- 'type' => 'string',
- 'example' => 'ENGLISH',
- ],
- 'grade' => [
- 'description' => '年级,取值范围1-9,对应年级level',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'volume' => [
- 'description' => '册次,0:全一册,1:上册,2:下册',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'author' => [
- 'description' => '作者信息',
- 'type' => 'string',
- 'example' => '吴欣',
- ],
- 'bookName' => [
- 'description' => '书本名称',
- 'type' => 'string',
- 'example' => 'K12英语-人教版PEP三起-三年级上册',
- ],
- 'coverImage' => [
- 'description' => '书本封面',
- 'type' => 'string',
- 'example' => 'null',
- ],
- ],
- ],
- ],
+ 'result' => ['title' => '润色结果', 'description' => '润色结果', 'type' => 'string', 'example' => 'Yes, I\'ll be right there.'],
],
+ 'example' => '[]',
],
],
],
],
- 403 => [
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": \\"Yes, I\'ll be right there.\\"\\n }\\n}","type":"json"}]',
+ 'title' => '执行拓展练润色',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueRefine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ExecuteAITeacherExpansionDialogueTranslate' => [
+ 'summary' => '拓展练语境翻译。',
+ 'path' => '/api/v1/aiteacher/expansionPractice/translate',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '259941',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录集合',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => ['title' => '角色身份', 'description' => '角色身份', 'type' => 'string', 'required' => true, 'example' => 'AI:assistant;用户:user'],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用。'."\n"
+ .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
+ .'跑题超过两次,取值会强制置为true,用于强制切换任务。', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => false,
],
- 'Code' => [
- 'type' => 'string',
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
],
- 'Success' => [
- 'type' => 'string',
+ 'background' => ['title' => '对话背景描述', 'description' => '对话背景描述', 'type' => 'string', 'required' => true, 'example' => 'In this dialogue, you will be playing the role of Lily, a young girl. I will be Jane, Lily\'s mother. We are in the kitchen, where I am preparing dinner. I am asking you about your food preferences, specifically if you like meat, fish, and milk. You like meat and milk, but you don\'t like fish because of its smell. I explain to you the nutritional benefits of these foods and suggest alternatives for the ones you don\'t like. Finally, I invite you to start eating.'],
+ 'roleInfo' => [
+ 'title' => '角色设置',
+ 'description' => '角色设置',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '教师扮演角色', 'description' => 'AI的名字', 'type' => 'string', 'required' => true, 'example' => 'Jane, a caring mother'],
+ 'user' => ['title' => '学生扮演者', 'description' => '用户的名字', 'type' => 'string', 'required' => true, 'example' => 'Lily, a friendly student'],
+ ],
+ 'required' => true,
],
- 'accessDeniedDetail' => [
+ 'topic' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'required' => true, 'example' => 'talk about food.'],
+ 'startSentence' => ['title' => '开场语', 'description' => '开场语', 'type' => 'string', 'required' => false, 'example' => 'Hello Lily, could you please come to the kitchen for a moment?'],
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
+ 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'result' => ['title' => '翻译结果', 'description' => '翻译结果', 'type' => 'string', 'example' => '太好了,谢谢你过来,莉莉。你喜欢吃肉吗?'],
],
+ 'example' => '[]',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": \\"太好了,谢谢你过来,莉莉。你喜欢吃肉吗?\\"\\n }\\n}","type":"json"}]',
+ 'title' => '执行拓展练翻译',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueTranslate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B695B377-7029-5805-9DE2-1AAE06C1BF6B\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"paginationData\\": {\\n \\"totalCount\\": 200,\\n \\"maxResults\\": 20,\\n \\"currentPage\\": 1\\n },\\n \\"bookList\\": [\\n {\\n \\"bookId\\": \\"231698\\",\\n \\"isbn\\": \\"9787107382505\\",\\n \\"edition\\": \\"2024-7(1)\\",\\n \\"impression\\": \\"2024-7(1)\\",\\n \\"publisher\\": \\"人民教育出版社\\",\\n \\"version\\": \\"人教版\\",\\n \\"subject\\": \\"ENGLISH\\",\\n \\"grade\\": \\"3\\",\\n \\"volume\\": \\"0\\",\\n \\"author\\": \\"吴欣\\",\\n \\"bookName\\": \\"K12英语-人教版PEP三起-三年级上册\\",\\n \\"coverImage\\": \\"null\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取英语教材的书本',
],
- 'ListTextbookAssistantBookDirectories' => [
- 'summary' => '获取书本下的目录信息。',
- 'path' => '/api/v1/textbookAssistant/teachingResource/ListBookDirectories',
- 'methods' => [
- 'post',
+ 'ExecuteAITeacherGrammarCheck' => [
+ 'summary' => '语法检测。',
+ 'path' => '/api/v1/aiteacher/common/grammarChecking',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '259934',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '待检测的语句', 'description' => '待检测的语句', 'type' => 'string', 'required' => true, 'example' => 'i is good'],
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiGrammarCheckDTO>',
+ 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiGrammarCheckDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'correctionStatus' => ['title' => '语法检测结果', 'description' => '语法检测结果', 'type' => 'string', 'example' => 'Has_Error'],
+ 'errorReason' => ['title' => '错误原因', 'description' => '错误原因', 'type' => 'string', 'example' => '暂无返回'],
+ 'correction' => ['title' => '纠错后的语句', 'description' => '纠错后的语句', 'type' => 'string', 'example' => 'I am good.'],
+ 'analysis' => ['title' => '错误分析', 'description' => '错误分析', 'type' => 'string', 'example' => '主语 "I" 对应的动词应该是 "am" 而不是 "is"。'],
+ ],
+ 'example' => '[]',
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"correctionStatus\\": \\"Has_Error\\",\\n \\"errorReason\\": \\"暂无返回\\",\\n \\"correction\\": \\"I am good.\\",\\n \\"analysis\\": \\"主语 \\\\\\"I\\\\\\" 对应的动词应该是 \\\\\\"am\\\\\\" 而不是 \\\\\\"is\\\\\\"。\\"\\n }\\n}","type":"json"}]',
+ 'title' => '执行语法检测',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherGrammarCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ExecuteAITeacherSyncDialogue' => [
+ 'summary' => '进行同步练对话。',
+ 'path' => '/api/v1/aiteacher/syncPractice/executeSyncTraining',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '261983',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '259253',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
@@ -3063,39 +2796,62 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体对象。',
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'bookId' => [
- 'description' => '书本编号Id,可以通过”获取英语教材的书本“接口中获取',
- 'type' => 'string',
- 'required' => true,
- 'example' => '231698',
- ],
- 'scenario' => [
- 'description' => '选择场景数据。SYNC:同步练习,EXPAND:拓展练习',
- 'type' => 'string',
- 'required' => true,
- 'docRequired' => true,
- 'enumValueTitles' => [
- 'EXPAND' => 'EXPAND:拓展练习',
- 'ALL' => 'ALL:全部',
- 'SYNC' => 'SYNC:同步练习',
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => [
+ 'title' => '角色身份',
+ 'description' => '角色身份',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['assistant' => 'AI ', 'user' => '用户'],
+ 'example' => 'AI:assistant;用户:user',
+ ],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用。'."\n"
+ .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
+ .'跑题超过两次,取值会强制置为true,用于强制切换任务。', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
],
- 'example' => 'SYNC',
- 'default' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- 'ALL',
+ 'required' => false,
+ ],
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => true,
+ 'description' => '',
],
+ 'required' => true,
],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。',
+ 'languageCode' => [
+ 'title' => '语言编码',
+ 'description' => '语言编码',
'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
+ 'required' => false,
+ 'enumValueTitles' => ['en-us' => '美式英语', 'en-gb' => '英式英语'],
+ 'example' => 'en-gb',
],
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
],
'required' => false,
],
@@ -3104,284 +2860,167 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'OpenApiSingleResponse<AITeacherSyncBasicTrainDTO>',
+ 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0A5E9849-A2F0-551D-A7D8-1A8118557BAB',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'B_USER_NOT_FOUND_EXCEPTION',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '用户不存在',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '返回数据对象',
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'editionInfo' => [
- 'description' => '版次信息',
- 'type' => 'object',
- 'properties' => [
- 'bookId' => [
- 'description' => '书本编号Id',
- 'type' => 'string',
- 'example' => '55857',
- ],
- 'isbn' => [
- 'description' => '国际标准书号',
- 'type' => 'string',
- 'example' => '9787544413695',
- ],
- 'edition' => [
- 'description' => '版次',
- 'type' => 'string',
- 'example' => '2010-1(2)',
- ],
- 'impression' => [
- 'description' => '印次',
- 'type' => 'string',
- 'example' => '2019-1(10)',
- ],
- 'publisher' => [
- 'description' => '出版社',
- 'type' => 'string',
- 'example' => '人民教育出版社',
- ],
- 'version' => [
- 'description' => '教材版本',
- 'type' => 'string',
- 'example' => '人教版',
- ],
- 'subject' => [
- 'description' => '学科',
- 'type' => 'string',
- 'example' => 'ENGLISH',
- ],
- 'grade' => [
- 'description' => '年级,取值范围1-9,和年级level对应',
- 'type' => 'string',
- 'example' => '3',
- ],
- 'bookVolume' => [
- 'description' => '册次,0:全一册,1:上册,2:下册',
- 'type' => 'string',
- 'example' => '1',
- ],
- ],
- ],
- 'directoryTree' => [
- 'description' => '目录数据结构',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'directoryId' => [
- 'description' => '目录ID',
- 'type' => 'string',
- 'example' => '05758807ed8e11eebe6e0c42a106bb02',
- ],
- 'directoryName' => [
- 'description' => '目录名称',
- 'type' => 'string',
- 'example' => '2 Jobs',
- ],
- 'topic' => [
- 'description' => '对话主题',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'labelId' => [
- 'description' => '标签ID',
- 'type' => 'string',
- 'example' => '1323',
- ],
- 'labelName' => [
- 'description' => '标签名称。',
- 'type' => 'string',
- 'example' => '身边事物环境',
- ],
- ],
- ],
- ],
- 'unit' => [
- 'description' => '单元信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'directoryId' => [
- 'description' => '目录ID',
- 'type' => 'string',
- 'example' => '05758807ed8e11eebe6e0c42a106bb02',
- ],
- 'directoryName' => [
- 'description' => '目录名称',
- 'type' => 'string',
- 'example' => 'unit 2',
- ],
- 'topic' => [
- 'description' => '话题名称',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'labelId' => [
- 'description' => '标签id',
- 'type' => 'string',
- 'example' => '1326',
- ],
- 'labelName' => [
- 'description' => '标签名称。',
- 'type' => 'string',
- 'example' => '自我介绍',
- ],
- ],
- ],
- ],
- 'section' => [
- 'description' => '句子信息',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'directoryId' => [
- 'description' => '目录ID',
- 'type' => 'string',
- 'example' => '05758807ed8e11eebe6e0c42a106bb02',
- ],
- 'directoryName' => [
- 'description' => '目录名称',
- 'type' => 'string',
- 'example' => 'section 2',
- ],
- 'topic' => [
- 'description' => '主题',
- 'type' => 'array',
- 'items' => [
- 'description' => '主题相关信息',
- 'type' => 'object',
- 'properties' => [
- 'labelId' => [
- 'description' => '标签ID',
- 'type' => 'string',
- 'example' => '1329',
- ],
- 'labelName' => [
- 'description' => '标签名称。',
- 'type' => 'string',
- 'example' => '自我介绍',
- ],
- ],
- ],
- ],
- 'children' => [
- 'description' => '可能存在的子元素,兼容数据使用,不一定存在',
- 'type' => 'any',
- 'example' => '可能存在的子元素,兼容数据使用,不一定存在',
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
- ],
+ 'englishResult' => ['title' => 'AI老师的英文回复', 'description' => 'AI老师的英文回复', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?'],
+ 'isFinish' => ['title' => '是否完成对话', 'description' => '是否完成对话', 'type' => 'boolean', 'example' => 'true'],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'example' => 'true'],
+ 'questionIndex' => ['title' => '当前作答的问题编号', 'description' => '当前作答的问题编号', 'type' => 'integer', 'format' => 'int32', 'example' => '2'],
],
+ 'example' => '[]',
],
],
],
],
- 403 => [
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"isFinish\\": true,\\n \\"isOnTopic\\": true,\\n \\"questionIndex\\": 2\\n }\\n}","type":"json"}]',
+ 'title' => '执行同步练',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherSyncDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ExecuteAITeacherSyncDialogueTranslate' => [
+ 'summary' => '同步练语境翻译。',
+ 'path' => '/api/v1/aiteacher/syncPractice/translate',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '259935',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => ['title' => '角色身份', 'description' => '角色身份', 'type' => 'string', 'required' => true, 'example' => 'AI:assistant;用户:user'],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => true,
+ ],
+ 'required' => false,
],
- 'Success' => [
- 'type' => 'string',
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
],
- 'accessDeniedDetail' => [
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
+ 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'result' => ['title' => '翻译结果', 'description' => '翻译结果', 'type' => 'string', 'example' => '太好了,谢谢你过来,莉莉。你喜欢吃肉吗?'],
],
+ 'example' => '[]',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A5E9849-A2F0-551D-A7D8-1A8118557BAB\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"editionInfo\\": {\\n \\"bookId\\": \\"55857\\",\\n \\"isbn\\": \\"9787544413695\\",\\n \\"edition\\": \\"2010-1(2)\\",\\n \\"impression\\": \\"2019-1(10)\\",\\n \\"publisher\\": \\"人民教育出版社\\",\\n \\"version\\": \\"人教版\\",\\n \\"subject\\": \\"ENGLISH\\",\\n \\"grade\\": \\"3\\",\\n \\"bookVolume\\": \\"1\\"\\n },\\n \\"directoryTree\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"2 Jobs\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1323\\",\\n \\"labelName\\": \\"身边事物环境\\"\\n }\\n ],\\n \\"unit\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"unit 2\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1326\\",\\n \\"labelName\\": \\"自我介绍\\"\\n }\\n ],\\n \\"section\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"section 2\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1329\\",\\n \\"labelName\\": \\"自我介绍\\"\\n }\\n ],\\n \\"children\\": \\"可能存在的子元素,兼容数据使用,不一定存在\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '获取英语教材的书本目录',
- ],
- 'ListTextbookAssistantArticles' => [
- 'summary' => '获取文章列表。',
- 'path' => '/api/v1/textbookAssistant/teachingResource/ListArticles',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": \\"太好了,谢谢你过来,莉莉。你喜欢吃肉吗?\\"\\n }\\n}","type":"json"}]',
+ 'title' => '执行同步练翻译',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherSyncDialogueTranslate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantDialogue' => [
+ 'summary' => '进行AI对话。',
+ 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteDialogue',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -3389,11 +3028,9 @@
],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'abilityTreeCode' => '261984',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '261986',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -3402,22 +3039,19 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求体对象。',
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'directoryId' => [
- 'description' => '目录ID。可以通过获取教材目录接口获取',
- 'type' => 'string',
- 'required' => true,
- 'example' => '90aa861b4d9311efbe6e0c42a106bb02',
- ],
- 'authToken' => [
- 'description' => '消息临时授权码,可以通过获取服务窗消息发送授权码接口获取。'."\n"
- ."\n",
+ 'scenario' => [
+ 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
'type' => 'string',
'required' => true,
- 'example' => 'tc_a893b8492c4be046cbc906c566aeb8c9',
+ 'example' => 'SYNC',
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
+ 'userMessage' => ['description' => '用户回复消息内容', 'type' => 'string', 'required' => true, 'example' => 'Hello'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
],
'required' => false,
],
@@ -3430,49 +3064,26 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '70412360-4272-571A-827D-84C2C07C450F',
- ],
- 'success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**:成功'."\n"
- ."\n"
- .'- **false**:失败',
- 'type' => 'boolean',
- 'enumValueTitles' => [],
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码'."\n"
- .'* 正确:errCode = 0'."\n"
- .'* 错误:errCode > 0,具体错误对应的错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP 状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'DBFA232A-1176-50E6-95AE-50F7A62A28AD'],
+ 'success' => ['description' => '是否成功', 'type' => 'string', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'null'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'string', 'example' => '200'],
'data' => [
- 'description' => '请求返回结果。',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'articleId' => [
- 'description' => '文章ID',
- 'type' => 'string',
- 'example' => '0c05700d4d9411efbe6e0c42a106bb02',
+ 'description' => '返回数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'example' => '6788e0b475a4631ffc626722'],
+ 'assistant' => ['description' => 'AI老师生成消息的编号', 'type' => 'string', 'example' => '6788f4935bdfc807f077a984'],
+ 'user' => ['description' => '用户回复消息的编号', 'type' => 'string', 'example' => '6788f4905bdfc807f077a982'],
+ 'result' => [
+ 'description' => '获取的数据内容',
+ 'type' => 'object',
+ 'properties' => [
+ 'englishResult' => ['description' => 'AI老师的英文回复', 'type' => 'string', 'example' => 'Let\'s look at the text again. Mike says, \\"I\'m Mike Black.\\" Can you try saying it like Mike?'],
+ 'chineseResult' => ['description' => 'AI老师的中文回复', 'type' => 'string', 'example' => '让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗?'],
+ 'isTaskCompleted' => ['description' => '是否完成任务', 'type' => 'boolean', 'example' => 'true'],
+ 'isFinish' => ['description' => '是否完成对话', 'type' => 'boolean', 'example' => 'true'],
],
],
],
@@ -3484,84 +3095,66 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"70412360-4272-571A-827D-84C2C07C450F\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"articleId\\": \\"0c05700d4d9411efbe6e0c42a106bb02\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取英语教材的文章列表',
- ],
- 'ListTextbookAssistantArticleDetails' => [
- 'summary' => '批量获取文章详情',
- 'path' => '/api/v1/textbookAssistant/teachingResource/ListArticleDetails',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DBFA232A-1176-50E6-95AE-50F7A62A28AD\\",\\n \\"success\\": \\"true\\",\\n \\"errCode\\": \\"null\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"chatId\\": \\"6788e0b475a4631ffc626722\\",\\n \\"assistant\\": \\"6788f4935bdfc807f077a984\\",\\n \\"user\\": \\"6788f4905bdfc807f077a982\\",\\n \\"result\\": {\\n \\"englishResult\\": \\"Let\'s look at the text again. Mike says, \\\\\\\\\\\\\\"I\'m Mike Black.\\\\\\\\\\\\\\" Can you try saying it like Mike?\\",\\n \\"chineseResult\\": \\"让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗?\\",\\n \\"isTaskCompleted\\": true,\\n \\"isFinish\\": true\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '与AI老师进行对话',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantDifficulty' => [
+ 'summary' => '调整难度',
+ 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteDifficulty',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '262952',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '262151',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -3570,25 +3163,25 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求body参数。',
'type' => 'object',
'properties' => [
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。',
+ 'scenario' => [
+ 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
'type' => 'string',
'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
+ 'example' => 'SYNC',
+ 'enum' => ['SYNC', 'EXPAND'],
],
- 'articleIdList' => [
- 'description' => '文章ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '文章ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '0c05700d4d9411efbe6e0c42a106bb02',
- ],
- 'required' => false,
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
+ 'assistant' => ['description' => 'AI老师生成消息的编号', 'type' => 'string', 'required' => true, 'example' => '6788f4a6b54c5268c1b78a25'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
+ 'action' => [
+ 'description' => '调整难度的类型',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'UP',
+ 'enum' => ['UP', 'DOWN'],
],
],
'required' => false,
@@ -3602,209 +3195,20 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**:成功'."\n"
- ."\n"
- .'- **false**:失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0D7D382F-9475-572E-BE83-DDFBF5C5EB24'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'null'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '返回数据对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'articleId' => [
- 'description' => '文章ID',
- 'type' => 'string',
- 'example' => '0c05700d4d9411efbe6e0c42a106bb02',
- ],
- 'target' => [
- 'description' => '练习目标',
- 'type' => 'string',
- 'example' => '1.能够在自我介绍时运用句型“What\'s your name? My name is/I‘m...”进行询问及回答。\\n2.能够和新朋友运用句型“Nice to meet you(too).”进行问候。',
- ],
- 'questionList' => [
- 'description' => '问答数据',
- 'type' => 'array',
- 'items' => [
- 'description' => '问题列表',
- 'type' => 'object',
- 'properties' => [
- 'question' => [
- 'description' => '问题内容。',
- 'type' => 'string',
- 'example' => 'From the book, how does Mike Black introduce himself?',
- ],
- 'questionTranslate' => [
- 'description' => '问题内容翻译的结果',
- 'type' => 'string',
- 'example' => '根据文章,迈克·布莱克是如何介绍自己的?',
- ],
- 'answer' => [
- 'description' => '问题对应的答案',
- 'type' => 'string',
- 'example' => 'I\'m Mike Black',
- ],
- ],
- ],
- ],
- 'sceneList' => [
- 'description' => '场景列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '场景列表数据',
- 'type' => 'object',
- 'properties' => [
- 'sceneId' => [
- 'description' => '场景Id',
- 'type' => 'string',
- 'example' => '38cddd70509911efbe6e0c42a106bb02',
- ],
- 'scene' => [
- 'description' => '场景描述',
- 'type' => 'string',
- 'example' => 'In the park, you introduce yourself to John and ask his name.',
- ],
- 'sceneImageList' => [
- 'description' => '当前场景相关图片',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png',
- ],
- ],
- 'sceneTranslate' => [
- 'type' => 'string',
- ],
- ],
- ],
- ],
- 'theme' => [
- 'description' => '主题信息',
- 'type' => 'object',
- 'properties' => [
- 'themeName' => [
- 'description' => '主题名称',
- 'type' => 'string',
- 'example' => '自我认知与提升',
- ],
- 'themeTranslate' => [
- 'description' => '主题名称翻译内容',
- 'type' => 'string',
- 'example' => 'Self-awareness, self-management, self-improvement',
- ],
- 'themeImageList' => [
- 'description' => '当前主题相关图片',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png',
- ],
- ],
- ],
- ],
- 'topic' => [
- 'description' => '话题信息',
- 'type' => 'object',
- 'properties' => [
- 'topicName' => [
- 'description' => '话题名称',
- 'type' => 'string',
- 'example' => '打招呼与自我介绍',
- ],
- 'topicTranslate' => [
- 'description' => '话题内容翻译',
- 'type' => 'string',
- 'example' => 'Greetings and self-introduction',
- ],
- 'topicImageList' => [
- 'description' => '当前话题相关图片',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png',
- ],
- ],
- ],
- ],
- 'sentenceList' => [
- 'description' => '句子信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '句子信息详情',
- 'type' => 'object',
- 'properties' => [
- 'sentenceId' => [
- 'description' => '句子Id',
- 'type' => 'string',
- 'example' => '4de677d2509811efbe6e0c42a106bb02',
- ],
- 'sentenceText' => [
- 'description' => '句子文本信息',
- 'type' => 'string',
- 'example' => 'I\'m Mike Black',
- ],
- 'sentenceAnalysis' => [
- 'description' => '句子分析,释义',
- 'type' => 'string',
- 'example' => '主语 + be动词(am/is/are) + 姓名.',
- ],
- ],
- ],
- ],
- 'wordList' => [
- 'description' => '单词信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '单词信息详情',
- 'type' => 'object',
- 'properties' => [
- 'wordId' => [
- 'description' => '单词id',
- 'type' => 'string',
- 'example' => 'a94df134ed8c11eebe6e0c42a106bb02',
- ],
- 'wordText' => [
- 'description' => '单词文本',
- 'type' => 'string',
- 'example' => 'nice',
- ],
- 'wordAnalysis' => [
- 'description' => '单词释义',
- 'type' => 'string',
- 'example' => '令人愉快的;友好的',
- ],
- ],
- ],
+ 'description' => '获取结果数据结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => [
+ 'description' => '结果数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => ['description' => '获取调整难度后的语句', 'type' => 'string', 'example' => 'Let\'s look at the text again. Mike says, \\"I\'m Mike Black.\\" Can you try saying it like Mike?'],
],
],
],
@@ -3816,84 +3220,66 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"articleId\\": \\"0c05700d4d9411efbe6e0c42a106bb02\\",\\n \\"target\\": \\"1.能够在自我介绍时运用句型“What\'s your name? My name is/I‘m...”进行询问及回答。\\\\\\\\n2.能够和新朋友运用句型“Nice to meet you(too).”进行问候。\\",\\n \\"questionList\\": [\\n {\\n \\"question\\": \\"From the book, how does Mike Black introduce himself?\\",\\n \\"questionTranslate\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\",\\n \\"answer\\": \\"I\'m Mike Black\\"\\n }\\n ],\\n \\"sceneList\\": [\\n {\\n \\"sceneId\\": \\"38cddd70509911efbe6e0c42a106bb02\\",\\n \\"scene\\": \\"In the park, you introduce yourself to John and ask his name.\\",\\n \\"sceneImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ],\\n \\"sceneTranslate\\": \\"\\"\\n }\\n ],\\n \\"theme\\": {\\n \\"themeName\\": \\"自我认知与提升\\",\\n \\"themeTranslate\\": \\"Self-awareness, self-management, self-improvement\\",\\n \\"themeImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"topic\\": {\\n \\"topicName\\": \\"打招呼与自我介绍\\",\\n \\"topicTranslate\\": \\"Greetings and self-introduction\\",\\n \\"topicImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"sentenceList\\": [\\n {\\n \\"sentenceId\\": \\"4de677d2509811efbe6e0c42a106bb02\\",\\n \\"sentenceText\\": \\"I\'m Mike Black\\",\\n \\"sentenceAnalysis\\": \\"主语 + be动词(am/is/are) + 姓名.\\"\\n }\\n ],\\n \\"wordList\\": [\\n {\\n \\"wordId\\": \\"a94df134ed8c11eebe6e0c42a106bb02\\",\\n \\"wordText\\": \\"nice\\",\\n \\"wordAnalysis\\": \\"令人愉快的;友好的\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取文章详情',
- ],
- 'ListTextbookAssistantSceneDetails' => [
- 'summary' => '获取文章内容详情',
- 'path' => '/api/v1/textbookAssistant/teachingResource/ListSceneDetails',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D7D382F-9475-572E-BE83-DDFBF5C5EB24\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"null\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"result\\": \\"Let\'s look at the text again. Mike says, \\\\\\\\\\\\\\"I\'m Mike Black.\\\\\\\\\\\\\\" Can you try saying it like Mike?\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '调整AI老师回复内容的难度',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantDifficulty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantGrammarCheck' => [
+ 'summary' => '语法检测',
+ 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteGrammarCheck',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '262951',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'create',
+ 'abilityTreeCode' => '262153',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -3905,23 +3291,16 @@
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。',
+ 'scenario' => [
+ 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
'type' => 'string',
- 'required' => false,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
- ],
- 'sceneIdList' => [
- 'description' => '场景ID列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '场景ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '38c41b7b509911efbe6e0c42a106bb02',
- ],
- 'required' => false,
+ 'required' => true,
+ 'example' => 'SYNC',
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
+ 'user' => ['description' => '用户回复消息编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b45bdfc807f077a5a1'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -3934,233 +3313,25 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'description' => '接口调用是否成功。'."\n"
- .'- **true**:成功'."\n"
- ."\n"
- .'- **false**:失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP 状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0bc1e96d17091734639835114e12c8'],
+ 'success' => ['description' => '是否请求成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '返回数据对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'sceneId' => [
- 'description' => '场景Id',
- 'type' => 'string',
- 'example' => '38c41b7b509911efbe6e0c42a106bb02',
- ],
- 'target' => [
- 'description' => '练习目标',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'scene' => [
- 'description' => '场景描述',
- 'type' => 'string',
- 'example' => 'At school, Carl sees a photo and asks you about your family.',
- ],
- 'sceneImageList' => [
- 'description' => '当前场景相关图片',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png',
- ],
- ],
- 'sceneTaskList' => [
- 'description' => '场景任务列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '任务信息',
- 'type' => 'object',
- 'properties' => [
- 'sceneTask' => [
- 'description' => '场景任务描述',
- 'type' => 'string',
- 'example' => 'Say that this is your dad\'s brother.',
- ],
- 'sceneTaskTranslate' => [
- 'description' => '场景任务描述释义',
- 'type' => 'string',
- 'example' => '说这是你爸爸的兄弟。',
- ],
- ],
- ],
- ],
- 'theme' => [
- 'description' => '主题信息',
- 'type' => 'object',
- 'properties' => [
- 'themeName' => [
- 'description' => '主题名称',
- 'type' => 'string',
- 'example' => '家庭生活',
- ],
- 'themeTranslate' => [
- 'description' => '主题名称翻译内容',
- 'type' => 'string',
- 'example' => 'Family and family life',
- ],
- 'themeImageList' => [
- 'description' => '当前主题相关图片',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png',
- ],
- ],
- ],
- ],
- 'topic' => [
- 'description' => '话题信息',
- 'type' => 'object',
- 'properties' => [
- 'topicName' => [
- 'description' => '话题名称',
- 'type' => 'string',
- 'example' => '介绍家人',
- ],
- 'topicTranslate' => [
- 'description' => '话题内容翻译',
- 'type' => 'string',
- 'example' => 'Introducing family members',
- ],
- 'topicImageList' => [
- 'description' => '当前话题相关图片',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片地址',
- 'type' => 'string',
- 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png',
- ],
- ],
- ],
- ],
- 'sentenceList' => [
- 'description' => '句子信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '句子详情。',
- 'type' => 'object',
- 'properties' => [
- 'sentenceId' => [
- 'description' => '句子编号ID',
- 'type' => 'string',
- 'example' => 'a774c6d09c4511eebe6e0c42a106bb02',
- ],
- 'sentenceText' => [
- 'description' => '句子文本信息',
- 'type' => 'string',
- 'example' => 'Is this your sister?',
- ],
- 'sentenceAnalysis' => [
- 'description' => '句子分析,释义',
- 'type' => 'string',
- 'example' => 'Is + this + your + 家庭成员?',
- ],
- ],
- ],
- ],
- 'wordList' => [
- 'description' => '单词信息列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '单词详情。',
- 'type' => 'object',
- 'properties' => [
- 'wordId' => [
- 'description' => '单词id',
- 'type' => 'string',
- 'example' => 'a94c3337ed8c11eebe6e0c42a106bb02',
- ],
- 'wordText' => [
- 'description' => '单词文本',
- 'type' => 'string',
- 'example' => 'family',
- ],
- 'wordAnalysis' => [
- 'description' => '单词释义',
- 'type' => 'string',
- 'example' => '家;家庭',
- ],
- ],
- ],
- ],
- 'roleList' => [
- 'description' => '角色列表',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'roleName' => [
- 'description' => '角色名称',
- 'type' => 'string',
- 'example' => 'Carl',
- ],
- 'roleNameTranslate' => [
- 'description' => '角色名称翻译结果',
- 'type' => 'string',
- 'example' => 'Carl',
- ],
- 'introduction' => [
- 'description' => '角色介绍',
- 'type' => 'string',
- 'example' => 'Carl, a curious boy',
- ],
- 'introductionTranslate' => [
- 'description' => '角色介绍翻译结果',
- 'type' => 'string',
- 'example' => 'Carl,一个好奇的男孩',
- ],
- 'promoting' => [
- 'description' => '角色引导文本',
- 'type' => 'string',
- 'example' => 'Hi Noah, who is that in the photo?',
- ],
- 'promotingTranslate' => [
- 'description' => '角色引导文本翻译结果',
- 'type' => 'string',
- 'example' => '嗨 Noah,照片里的人是谁?',
- ],
- 'roleType' => [
- 'description' => '角色类型(0为提问者AI,1为回答者)',
- 'type' => 'string',
- 'example' => '0',
- ],
- ],
- ],
- ],
- 'sceneTranslate' => [
- 'type' => 'string',
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'result' => [
+ 'description' => '结果数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'correction' => ['description' => '纠错后的语句', 'type' => 'string', 'example' => 'I am you.'],
+ 'analysis' => ['description' => '错误分析', 'type' => 'string', 'example' => '主语 \\"I\\" 后应跟动词 \\"am\\" 而不是 \\"are\\"。'],
+ 'correctionStatus' => ['description' => '语法检测结果'."\n"
+ .'有错误: Has_Error'."\n"
+ .'无错误: No_Error'."\n"
+ .'无法解析语句: Invalid_Sentence', 'type' => 'string', 'example' => 'Has_Error'],
],
],
],
@@ -4172,69 +3343,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"sceneId\\": \\"38c41b7b509911efbe6e0c42a106bb02\\",\\n \\"target\\": \\"\\\\\\"\\\\\\"\\",\\n \\"scene\\": \\"At school, Carl sees a photo and asks you about your family.\\",\\n \\"sceneImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ],\\n \\"sceneTaskList\\": [\\n {\\n \\"sceneTask\\": \\"Say that this is your dad\'s brother.\\",\\n \\"sceneTaskTranslate\\": \\"说这是你爸爸的兄弟。\\"\\n }\\n ],\\n \\"theme\\": {\\n \\"themeName\\": \\"家庭生活\\",\\n \\"themeTranslate\\": \\"Family and family life\\",\\n \\"themeImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"topic\\": {\\n \\"topicName\\": \\"介绍家人\\",\\n \\"topicTranslate\\": \\"Introducing family members\\",\\n \\"topicImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"sentenceList\\": [\\n {\\n \\"sentenceId\\": \\"a774c6d09c4511eebe6e0c42a106bb02\\",\\n \\"sentenceText\\": \\"Is this your sister?\\",\\n \\"sentenceAnalysis\\": \\"Is + this + your + 家庭成员?\\"\\n }\\n ],\\n \\"wordList\\": [\\n {\\n \\"wordId\\": \\"a94c3337ed8c11eebe6e0c42a106bb02\\",\\n \\"wordText\\": \\"family\\",\\n \\"wordAnalysis\\": \\"家;家庭\\"\\n }\\n ],\\n \\"roleList\\": [\\n {\\n \\"roleName\\": \\"Carl\\",\\n \\"roleNameTranslate\\": \\"Carl\\",\\n \\"introduction\\": \\"Carl, a curious boy\\",\\n \\"introductionTranslate\\": \\"Carl,一个好奇的男孩\\",\\n \\"promoting\\": \\"Hi Noah, who is that in the photo?\\",\\n \\"promotingTranslate\\": \\"嗨 Noah,照片里的人是谁?\\",\\n \\"roleType\\": \\"0\\"\\n }\\n ],\\n \\"sceneTranslate\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '获取场景详情',
- ],
- 'ExecuteTextbookAssistantStartConversation' => [
- 'summary' => '发起与AI老师的对话,由Ai老师率先发起第一句对话内容。',
- 'path' => '/api/v1/textbookAssistant/dialogue/StartConversation',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0bc1e96d17091734639835114e12c8\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"correction\\": \\"I am you.\\",\\n \\"analysis\\": \\"主语 \\\\\\\\\\\\\\"I\\\\\\\\\\\\\\" 后应跟动词 \\\\\\\\\\\\\\"am\\\\\\\\\\\\\\" 而不是 \\\\\\\\\\\\\\"are\\\\\\\\\\\\\\"。\\",\\n \\"correctionStatus\\": \\"Has_Error\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '获取用户回复内容的语法检测的结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantGrammarCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantRefineByContext' => [
+ 'summary' => '句子润色',
+ 'path' => '/api/v1/textbookAssistant/dialogue/RefineByContext',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4243,10 +3401,8 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '261985',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeCode' => '262154',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -4255,43 +3411,19 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数。',
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
- ],
'scenario' => [
- 'description' => '选择场景。'."\n"
- ."\n"
- .'SYNC:同步练习'."\n"
- ."\n"
- .'EXPAND:拓展练习',
+ 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
'type' => 'string',
'required' => true,
'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'articleId' => [
- 'description' => '文章ID,获取方式如下:'."\n"
- ."\n"
- .'**scenario入参选择SYNC时:**'."\n"
- .'1. 接口名称:获取英语教材的文章列表    来源字段:响应参数顶层 articleId'."\n"
- .'2. 接口名称:获取文章详情    来源字段:响应参数顶层 articleId'."\n"
- ."\n"
- .'**scenario入参选择EXPAND时:**'."\n"
- ."\n"
- .'1. 接口名称:获取文章详情    来源字段:sceneList 数组内元素的 sceneid 字段',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0c05700d4d9411efbe6e0c42a106bb02',
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
+ 'user' => ['description' => '用户回复消息的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b45bdfc807f077a5a1'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -4304,66 +3436,20 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '6F73C114-A76E-51AD-99E3-BC7B941B69E0',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'B_USER_NOT_FOUND_EXCEPTION'."\n",
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '用户不存在',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6F73C114-A76E-51AD-99E3-BC7B941B69E0'],
+ 'success' => ['description' => '请求是否成功。', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'integer', 'format' => 'int32', 'example' => 'null'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'string', 'example' => '200'],
'data' => [
- 'description' => '返回数据对象',
+ 'description' => '获取结果数据结构体',
'type' => 'object',
'properties' => [
- 'chatId' => [
- 'description' => '本轮对话的ID',
- 'type' => 'string',
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'assistant' => [
- 'description' => 'AI老师生成消息的编号',
- 'type' => 'string',
- 'example' => '6788e0b4b54c5268c1b78638',
- ],
- 'user' => [
- 'description' => '用户生成消息的编号',
- 'type' => 'string',
- 'example' => '6788e0b45bdfc807f077a5a1',
- ],
'result' => [
- 'description' => '结果消息数据',
+ 'description' => '结果数据',
'type' => 'object',
'properties' => [
- 'englishResult' => [
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => 'Good evening! From the book, how does Mike Black introduce himself?',
- ],
- 'chineseResult' => [
- 'description' => 'AI老师的中文回复',
- 'type' => 'string',
- 'example' => '根据文章,迈克·布莱克是如何介绍自己的?',
- ],
+ 'result' => ['description' => '润色用户内容的结果', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?'],
],
],
],
@@ -4375,69 +3461,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
- 'accessDeniedDetail' => [
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6F73C114-A76E-51AD-99E3-BC7B941B69E0\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\\\n\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"chatId\\": \\"6788e0b475a4631ffc626722\\",\\n \\"assistant\\": \\"6788e0b4b54c5268c1b78638\\",\\n \\"user\\": \\"6788e0b45bdfc807f077a5a1\\",\\n \\"result\\": {\\n \\"englishResult\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\",\\n \\"chineseResult\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '开启与AI老师的对话',
- ],
- 'ExecuteTextbookAssistantDialogue' => [
- 'summary' => '进行AI对话。',
- 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteDialogue',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6F73C114-A76E-51AD-99E3-BC7B941B69E0\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": 0,\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"result\\": {\\n \\"result\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '获取润色用户回复消息内容的结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantRefineByContext',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantRetryConversation' => [
+ 'summary' => '对话重试',
+ 'path' => '/api/v1/textbookAssistant/dialogue/RetryConversation',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4446,10 +3519,8 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '261986',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeCode' => '262152',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -4466,29 +3537,11 @@
'type' => 'string',
'required' => true,
'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'userMessage' => [
- 'description' => '用户回复消息内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Hello',
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
+ 'assistant' => ['description' => 'AI老师生成消息的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -4501,75 +3554,24 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'DBFA232A-1176-50E6-95AE-50F7A62A28AD',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'string',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2F2ABF4B-A4F6-5EC7-B287-7EF5B156F1ED'],
+ 'success' => ['description' => '调用是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'description' => '返回数据对象',
'type' => 'object',
'properties' => [
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'assistant' => [
- 'description' => 'AI老师生成消息的编号',
- 'type' => 'string',
- 'example' => '6788f4935bdfc807f077a984',
- ],
- 'user' => [
- 'description' => '用户回复消息的编号',
- 'type' => 'string',
- 'example' => '6788f4905bdfc807f077a982',
- ],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'example' => '6788e0b475a4631ffc626722'],
+ 'assistant' => ['description' => 'AI老师回复消息编号', 'type' => 'string', 'example' => '6788e0b4b54c5268c1b78638'],
+ 'user' => ['description' => '用户回复消息编号', 'type' => 'string', 'example' => '6788e0b45bdfc807f077a5a1'],
'result' => [
- 'description' => '获取的数据内容',
+ 'description' => '结果数据',
'type' => 'object',
'properties' => [
- 'englishResult' => [
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => 'Let\'s look at the text again. Mike says, \\"I\'m Mike Black.\\" Can you try saying it like Mike?',
- ],
- 'chineseResult' => [
- 'description' => 'AI老师的中文回复',
- 'type' => 'string',
- 'example' => '让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗?',
- ],
- 'isTaskCompleted' => [
- 'description' => '是否完成任务',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'isFinish' => [
- 'description' => '是否完成对话',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'englishResult' => ['description' => 'AI老师的英文回复', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?'],
+ 'chineseResult' => ['description' => 'AI老师的中文回复', 'type' => 'string', 'example' => '根据文章,迈克·布莱克是如何介绍自己的?'],
],
],
],
@@ -4581,70 +3583,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2F2ABF4B-A4F6-5EC7-B287-7EF5B156F1ED\\",\\n \\"success\\": true,\\n \\"errMessage\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"chatId\\": \\"6788e0b475a4631ffc626722\\",\\n \\"assistant\\": \\"6788e0b4b54c5268c1b78638\\",\\n \\"user\\": \\"6788e0b45bdfc807f077a5a1\\",\\n \\"result\\": {\\n \\"englishResult\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\",\\n \\"chineseResult\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '重新生成AI老师的提问内容',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantRetryConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"DBFA232A-1176-50E6-95AE-50F7A62A28AD\\",\\n \\"success\\": \\"true\\",\\n \\"errCode\\": \\"null\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"chatId\\": \\"6788e0b475a4631ffc626722\\",\\n \\"assistant\\": \\"6788f4935bdfc807f077a984\\",\\n \\"user\\": \\"6788f4905bdfc807f077a982\\",\\n \\"result\\": {\\n \\"englishResult\\": \\"Let\'s look at the text again. Mike says, \\\\\\\\\\\\\\"I\'m Mike Black.\\\\\\\\\\\\\\" Can you try saying it like Mike?\\",\\n \\"chineseResult\\": \\"让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗?\\",\\n \\"isTaskCompleted\\": true,\\n \\"isFinish\\": true\\n }\\n }\\n}","type":"json"}]',
- 'title' => '与AI老师进行对话',
],
'ExecuteTextbookAssistantSseDialogue' => [
'summary' => '进行对话-流式输出',
'path' => '/api/v1/textbookAssistant/dialogue/ExecuteSseDialogue',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- 'sse',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
@@ -4656,9 +3644,7 @@
'operationType' => 'none',
'riskType' => 'none',
'abilityTreeCode' => '268248',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -4676,32 +3662,11 @@
'type' => 'string',
'required' => true,
'example' => 'EXPAND',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'chatId' => [
- 'title' => '本轮对话的编号',
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '67e374acb54c526c95c4fbd4',
- ],
- 'userMessage' => [
- 'title' => '用户回复消息内容',
- 'description' => '用户回复消息内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'hello',
- ],
- 'authToken' => [
- 'title' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'chatId' => ['title' => '本轮对话的编号', 'description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '67e374acb54c526c95c4fbd4'],
+ 'userMessage' => ['title' => '用户回复消息内容', 'description' => '用户回复消息内容', 'type' => 'string', 'required' => true, 'example' => 'hello'],
+ 'authToken' => ['title' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -4714,67 +3679,25 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'chatId' => [
- 'title' => '本轮对话的编号',
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'example' => '67e374acb54c526c95c4fbd4',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'chatId' => ['title' => '本轮对话的编号', 'description' => '本轮对话的编号', 'type' => 'string', 'example' => '67e374acb54c526c95c4fbd4'],
'data' => [
'title' => '返回数据对象',
'description' => '返回数据对象',
'type' => 'object',
'properties' => [
- 'englishResult' => [
- 'title' => 'AI老师的英文回复',
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => 'Thanks, Lily. Do you like meat, Lily?',
- ],
- 'isFinish' => [
- 'title' => '是否完成对话',
- 'description' => '是否完成对话',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
+ 'englishResult' => ['title' => 'AI老师的英文回复', 'description' => 'AI老师的英文回复', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?'],
+ 'isFinish' => ['title' => '是否完成对话', 'description' => '是否完成对话', 'type' => 'boolean', 'example' => 'true'],
],
],
- 'assistant' => [
- 'title' => 'AI老师生成消息的编号',
- 'description' => 'AI老师生成消息的编号',
- 'type' => 'string',
- 'example' => '67e4c9d95bdfc83cd742ae7c',
- ],
- 'user' => [
- 'title' => '用户回复消息的编号',
- 'description' => '用户回复消息的编号',
- 'type' => 'string',
- 'example' => '67e4c9d6b54c526c95c53925',
- ],
- 'success' => [
- 'description' => '调用是否成功:'."\n"
- ."\n"
- .'- **true**:成功'."\n"
- .'- **false**:失败',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'BIZ_ERROR',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '执行对话流式输出服务错误,请重试:资源信息不存在',
- ],
+ 'assistant' => ['title' => 'AI老师生成消息的编号', 'description' => 'AI老师生成消息的编号', 'type' => 'string', 'example' => '67e4c9d95bdfc83cd742ae7c'],
+ 'user' => ['title' => '用户回复消息的编号', 'description' => '用户回复消息的编号', 'type' => 'string', 'example' => '67e4c9d6b54c526c95c53925'],
+ 'success' => ['description' => '调用是否成功:'."\n"
+ ."\n"
+ .'- **true**:成功'."\n"
+ .'- **false**:失败', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'BIZ_ERROR'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '执行对话流式输出服务错误,请重试:资源信息不存在'],
],
],
],
@@ -4782,19 +3705,12 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'success' => [
- 'type' => 'string',
- ],
- 'errCode' => [
- 'type' => 'string',
- ],
- 'errMessage' => [
- 'type' => 'string',
- ],
- 'requestId' => [
- 'type' => 'string',
- ],
+ 'success' => ['type' => 'string', 'description' => ''],
+ 'errCode' => ['type' => 'string', 'description' => ''],
+ 'errMessage' => ['type' => 'string', 'description' => ''],
+ 'requestId' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
403 => [
@@ -4804,48 +3720,47 @@
'AccessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"chatId\\": \\"67e374acb54c526c95c4fbd4\\",\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"isFinish\\": true\\n },\\n \\"assistant\\": \\"67e4c9d95bdfc83cd742ae7c\\",\\n \\"user\\": \\"67e4c9d6b54c526c95c53925\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"BIZ_ERROR\\",\\n \\"errMessage\\": \\"执行对话流式输出服务错误,请重试:资源信息不存在\\"\\n}","type":"json"}]',
'title' => 'AI老师进行对话-流式输出',
- ],
- 'ExecuteTextbookAssistantTranslate' => [
- 'summary' => '翻译消息内容',
- 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteTranslate',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantSseDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantStartConversation' => [
+ 'summary' => '发起与AI老师的对话,由Ai老师率先发起第一句对话内容。',
+ 'path' => '/api/v1/textbookAssistant/dialogue/StartConversation',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -4854,10 +3769,8 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '261987',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeCode' => '261985',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -4866,37 +3779,30 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求body参数。',
'type' => 'object',
'properties' => [
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
'scenario' => [
- 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
+ 'description' => '选择场景。'."\n"
+ ."\n"
+ .'SYNC:同步练习'."\n"
+ ."\n"
+ .'EXPAND:拓展练习',
'type' => 'string',
'required' => true,
'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'assistant' => [
- 'description' => 'AI老师生成消息的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b4b54c5268c1b78638',
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
- ],
+ 'enum' => ['SYNC', 'EXPAND'],
+ ],
+ 'articleId' => ['description' => '文章ID,获取方式如下:'."\n"
+ ."\n"
+ .'**scenario入参选择SYNC时:**'."\n"
+ .'1. 接口名称:获取英语教材的文章列表    来源字段:响应参数顶层 articleId'."\n"
+ .'2. 接口名称:获取文章详情    来源字段:响应参数顶层 articleId'."\n"
+ ."\n"
+ .'**scenario入参选择EXPAND时:**'."\n"
+ ."\n"
+ .'1. 接口名称:获取文章详情    来源字段:sceneList 数组内元素的 sceneid 字段', 'type' => 'string', 'required' => true, 'example' => '0c05700d4d9411efbe6e0c42a106bb02'],
],
'required' => false,
],
@@ -4909,45 +3815,24 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '9EB79C1E-36C2-5777-BED6-C23A98DF0637',
- ],
- 'success' => [
- 'description' => '调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '""',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码。',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6F73C114-A76E-51AD-99E3-BC7B941B69E0'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'B_USER_NOT_FOUND_EXCEPTION'."\n"],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '用户不存在'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'description' => '返回数据对象',
'type' => 'object',
'properties' => [
+ 'chatId' => ['description' => '本轮对话的ID', 'type' => 'string', 'example' => '6788e0b475a4631ffc626722'],
+ 'assistant' => ['description' => 'AI老师生成消息的编号', 'type' => 'string', 'example' => '6788e0b4b54c5268c1b78638'],
+ 'user' => ['description' => '用户生成消息的编号', 'type' => 'string', 'example' => '6788e0b45bdfc807f077a5a1'],
'result' => [
- 'description' => '获取结果数据结构体',
+ 'description' => '结果消息数据',
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => '翻译结果数据',
- 'type' => 'string',
- 'example' => '根据文章,迈克·布莱克是如何介绍自己的?',
- ],
+ 'englishResult' => ['description' => 'AI老师的英文回复', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?'],
+ 'chineseResult' => ['description' => 'AI老师的中文回复', 'type' => 'string', 'example' => '根据文章,迈克·布莱克是如何介绍自己的?'],
],
],
],
@@ -4959,69 +3844,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6F73C114-A76E-51AD-99E3-BC7B941B69E0\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\\\n\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"chatId\\": \\"6788e0b475a4631ffc626722\\",\\n \\"assistant\\": \\"6788e0b4b54c5268c1b78638\\",\\n \\"user\\": \\"6788e0b45bdfc807f077a5a1\\",\\n \\"result\\": {\\n \\"englishResult\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\",\\n \\"chineseResult\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '开启与AI老师的对话',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantStartConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9EB79C1E-36C2-5777-BED6-C23A98DF0637\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"result\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取对话消息的翻译结果',
],
'ExecuteTextbookAssistantSuggestion' => [
'summary' => '获取鉴权参数',
'path' => '/api/v1/textbookAssistant/dialogue/Suggestion',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5031,9 +3903,7 @@
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '262023',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -5045,34 +3915,16 @@
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b4b54c5268c1b78638',
- ],
- 'assistant' => [
- 'description' => 'AI老师提问内容的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b4b54c5268c1b78638',
- ],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638'],
+ 'assistant' => ['description' => 'AI老师提问内容的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638'],
'scenario' => [
'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
'type' => 'string',
'required' => true,
'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -5085,32 +3937,11 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0D7D382F-9475-572E-BE83-DDFBF5C5EB24',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'httpstatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '0D7D382F-9475-572E-BE83-DDFBF5C5EB24'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => 'null'],
+ 'httpstatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'description' => '返回数据对象',
'type' => 'object',
@@ -5119,16 +3950,8 @@
'description' => '结果数据',
'type' => 'object',
'properties' => [
- 'englishResult' => [
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => 'Good evening! From the book, how does Mike Black introduce himself?',
- ],
- 'chineseResult' => [
- 'description' => 'AI老师的中文回复',
- 'type' => 'string',
- 'example' => '根据文章,迈克·布莱克是如何介绍自己的?',
- ],
+ 'englishResult' => ['description' => 'AI老师的英文回复', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?'],
+ 'chineseResult' => ['description' => 'AI老师的中文回复', 'type' => 'string', 'example' => '根据文章,迈克·布莱克是如何介绍自己的?'],
],
],
],
@@ -5140,69 +3963,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'type' => 'string',
- ],
- 'RequesId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'RequesId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D7D382F-9475-572E-BE83-DDFBF5C5EB24\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpstatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"englishResult\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\",\\n \\"chineseResult\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
'title' => '获取对话中AI老师提问的建议回复内容',
- ],
- 'ExecuteTextbookAssistantDifficulty' => [
- 'summary' => '调整难度',
- 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteDifficulty',
- 'methods' => [
- 'post',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantSuggestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ExecuteTextbookAssistantTranslate' => [
+ 'summary' => '翻译消息内容',
+ 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteTranslate',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5211,10 +4021,8 @@
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '262151',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'abilityTreeCode' => '261987',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -5223,7 +4031,7 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数。',
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
'scenario' => [
@@ -5231,39 +4039,11 @@
'type' => 'string',
'required' => true,
'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'assistant' => [
- 'description' => 'AI老师生成消息的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788f4a6b54c5268c1b78a25',
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
- ],
- 'action' => [
- 'description' => '调整难度的类型',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'UP',
- 'enum' => [
- 'UP',
- 'DOWN',
- ],
+ 'enum' => ['SYNC', 'EXPAND'],
],
+ 'chatId' => ['description' => '本轮对话的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722'],
+ 'assistant' => ['description' => 'AI老师生成消息的编号', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -5276,46 +4056,20 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0D7D382F-9475-572E-BE83-DDFBF5C5EB24',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['description' => 'Id of the request', 'type' => 'string', 'example' => '9EB79C1E-36C2-5777-BED6-C23A98DF0637'],
+ 'success' => ['description' => '调用是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '""'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '获取结果数据结构体',
+ 'description' => '返回数据对象',
'type' => 'object',
'properties' => [
'result' => [
- 'description' => '结果数据',
+ 'description' => '获取结果数据结构体',
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => '获取调整难度后的语句',
- 'type' => 'string',
- 'example' => 'Let\'s look at the text again. Mike says, \\"I\'m Mike Black.\\" Can you try saying it like Mike?',
- ],
+ 'result' => ['description' => '翻译结果数据', 'type' => 'string', 'example' => '根据文章,迈克·布莱克是如何介绍自己的?'],
],
],
],
@@ -5327,69 +4081,56 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'Success' => [
- 'type' => 'string',
- ],
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0D7D382F-9475-572E-BE83-DDFBF5C5EB24\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"null\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"result\\": \\"Let\'s look at the text again. Mike says, \\\\\\\\\\\\\\"I\'m Mike Black.\\\\\\\\\\\\\\" Can you try saying it like Mike?\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '调整AI老师回复内容的难度',
- ],
- 'ExecuteTextbookAssistantRefineByContext' => [
- 'summary' => '句子润色',
- 'path' => '/api/v1/textbookAssistant/dialogue/RefineByContext',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"9EB79C1E-36C2-5777-BED6-C23A98DF0637\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"\\\\\\"\\\\\\"\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"result\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
+ 'title' => '获取对话消息的翻译结果',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantTranslate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetAITeacherExpansionDialogueSuggestion' => [
+ 'summary' => '拓展练小助手。',
+ 'path' => '/api/v1/aiteacher/expansionPractice/suggestion',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -5397,12 +4138,9 @@
],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '262154',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
- 'tenantRelevance' => 'tenant',
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '259938',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
],
'parameters' => [
[
@@ -5413,34 +4151,72 @@
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'scenario' => [
- 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => [
+ 'title' => '角色身份',
+ 'description' => '角色身份',
+ 'type' => 'string',
+ 'required' => true,
+ 'enumValueTitles' => ['assistant' => '老师', 'user' => '学生'],
+ 'example' => 'AI:assistant;用户:user',
+ ],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用。'."\n"
+ .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
+ .'跑题超过两次,取值会强制置为true,用于强制切换任务。', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
],
- ],
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
],
- 'user' => [
- 'description' => '用户回复消息的编号',
- 'type' => 'string',
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话任务结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
'required' => true,
- 'example' => '6788e0b45bdfc807f077a5a1',
],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
+ 'languageCode' => [
+ 'title' => '语言编码',
+ 'description' => '语言编码',
'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['en-us' => '美式英语', 'en-gb' => '英式英语'],
+ 'example' => 'en-gb',
+ ],
+ 'background' => ['title' => '对话背景描述', 'description' => '对话背景描述', 'type' => 'string', 'required' => true, 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.'],
+ 'roleInfo' => [
+ 'title' => '角色设置',
+ 'description' => '角色设置',
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师扮演者', 'description' => 'AI的名字', 'type' => 'string', 'required' => true, 'example' => 'Alex'],
+ 'user' => ['title' => '学生扮演者', 'description' => '用户的名字', 'type' => 'string', 'required' => true, 'example' => 'Jamie'],
+ ],
'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
],
+ 'topic' => ['title' => '主题', 'description' => '主题', 'type' => 'string', 'required' => true, 'example' => 'Let\'s talk about traffic rules.'],
+ 'startSentence' => ['title' => '开场语', 'description' => '开场语', 'type' => 'string', 'required' => false, 'example' => 'Hello Lily, could you please come to the kitchen for a moment?'],
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
],
'required' => false,
],
@@ -5449,136 +4225,190 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => 'Schema of Response',
+ 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
+ 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '6F73C114-A76E-51AD-99E3-BC7B941B69E0',
- ],
- 'success' => [
- 'description' => '请求是否成功。',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => 'null',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'string',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '获取结果数据结构体',
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => '结果数据',
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'description' => '润色用户内容的结果',
- 'type' => 'string',
- 'example' => 'Good evening! From the book, how does Mike Black introduce himself?',
- ],
- ],
- ],
+ 'englishResult' => ['title' => '小助手的英文提示', 'description' => '小助手的英文提示', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?'],
+ 'chineseResult' => ['title' => '小助手的中文提示', 'description' => '小助手的中文提示', 'type' => 'string', 'example' => '谢谢莉莉.你喜欢吃肉吗,莉莉?'],
],
+ 'example' => '[]',
],
],
],
],
- 403 => [
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"chineseResult\\": \\"谢谢莉莉.你喜欢吃肉吗,莉莉?\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取拓展练小助手提示',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:GetAITeacherExpansionDialogueSuggestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'GetAITeacherSyncDialogueSuggestion' => [
+ 'summary' => '同步练小助手。',
+ 'path' => '/api/v1/aiteacher/syncPractice/suggestion',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '259937',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
+ 'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
+ 'records' => [
+ 'title' => '对话记录',
+ 'description' => '对话记录集合',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '对话记录结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'content' => ['title' => '对话内容', 'description' => '对话内容', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.'],
+ 'role' => ['title' => '角色身份', 'description' => '角色身份', 'type' => 'string', 'required' => true, 'example' => 'AI:assistant;用户:user'],
+ 'isOnTopic' => ['title' => '是否扣题', 'description' => '是否扣题', 'type' => 'boolean', 'required' => false, 'example' => '扣题:true, 不扣题:false'],
+ 'isOffTopicControl' => ['title' => '是否跑题,带流程控制作用', 'description' => '是否跑题,带流程控制作用。'."\n"
+ .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
+ .'跑题超过两次,取值会强制置为true,用于强制切换任务。', 'type' => 'boolean', 'required' => false, 'example' => '跑题:true, 不跑题:false'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ 'required' => true,
],
- 'Code' => [
- 'type' => 'string',
+ 'dialogueTasks' => [
+ 'title' => '对话任务对话内容集合',
+ 'description' => '对话任务对话内容集合',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'assistant' => ['title' => '老师对话内容', 'description' => 'AI对话内容', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?'],
+ 'assistantTranslate' => ['title' => '老师对话内容翻译', 'description' => 'AI对话内容翻译', 'type' => 'string', 'required' => false, 'example' => '为什么有些人认为遛狗是份好差事?'],
+ 'user' => ['title' => '学生对话内容', 'description' => '用户对话内容', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.'],
+ 'order' => ['title' => '排序编号', 'description' => '排序编号', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'],
+ ],
+ 'required' => false,
+ 'description' => '',
+ ],
+ 'required' => true,
],
- 'Success' => [
+ 'languageCode' => [
+ 'title' => '语言编码',
+ 'description' => '语言编码',
'type' => 'string',
+ 'required' => false,
+ 'enumValueTitles' => ['en-us' => '美式英语', 'en-gb' => '英式英语'],
+ 'example' => 'en-gb',
],
- 'AccessDeniedDetail' => [
+ 'userId' => ['title' => '用户Id', 'description' => '用户Id', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
+ 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'englishResult' => ['title' => '小助手的英文提示', 'description' => '小助手的英文提示', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?'],
+ 'chineseResult' => ['title' => '小助手的中文提示', 'description' => '小助手的中文提示', 'type' => 'string', 'example' => '谢谢莉莉.你喜欢吃肉吗,莉莉?'],
],
+ 'example' => '[]',
],
],
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"chineseResult\\": \\"谢谢莉莉.你喜欢吃肉吗,莉莉?\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取同步练小助手提示',
+ 'changeSet' => [
+ ['createdAt' => '2024-12-30T02:53:35.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"6F73C114-A76E-51AD-99E3-BC7B941B69E0\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": 0,\\n \\"httpStatusCode\\": \\"200\\",\\n \\"data\\": {\\n \\"result\\": {\\n \\"result\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取润色用户回复消息内容的结果',
- ],
- 'ExecuteTextbookAssistantGrammarCheck' => [
- 'summary' => '语法检测',
- 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteGrammarCheck',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:GetAITeacherSyncDialogueSuggestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'GetTextbookAssistantToken' => [
+ 'summary' => '获取请求调用授权码。',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/GetToken',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => [],
+ 'produces' => [],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '262153',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'get',
+ 'abilityTreeCode' => '261955',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -5587,37 +4417,11 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求体对象。',
'type' => 'object',
'properties' => [
- 'scenario' => [
- 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'user' => [
- 'description' => '用户回复消息编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b45bdfc807f077a5a1',
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
- ],
+ 'deviceId' => ['description' => '设备ID。', 'type' => 'string', 'required' => true, 'example' => '700d4d9411efbe6e0'],
+ 'model' => ['description' => '设备型号。', 'type' => 'string', 'required' => true, 'example' => '25032PS56C'],
],
'required' => false,
],
@@ -5630,61 +4434,20 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '0bc1e96d17091734639835114e12c8',
- ],
- 'success' => [
- 'description' => '是否请求成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0A5E9849-A2F0-551D-A7D8-1A8118557BAB'],
+ 'success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**:成功'."\n"
+ ."\n"
+ .'- **false**:失败', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['description' => 'HTTP 状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '数据对象',
+ 'description' => '返回数据对象。',
'type' => 'object',
'properties' => [
- 'result' => [
- 'description' => '结果数据',
- 'type' => 'object',
- 'properties' => [
- 'correction' => [
- 'description' => '纠错后的语句',
- 'type' => 'string',
- 'example' => 'I am you.',
- ],
- 'analysis' => [
- 'description' => '错误分析',
- 'type' => 'string',
- 'example' => '主语 \\"I\\" 后应跟动词 \\"am\\" 而不是 \\"are\\"。',
- ],
- 'correctionStatus' => [
- 'description' => '语法检测结果'."\n"
- .'有错误: Has_Error'."\n"
- .'无错误: No_Error'."\n"
- .'无法解析语句: Invalid_Sentence',
- 'type' => 'string',
- 'example' => 'Has_Error',
- ],
- ],
- ],
+ 'expire' => ['description' => '授权码有效期(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '5400'],
+ 'authToken' => ['description' => '授权码,用于调用英语教材式AI老师的其他接口。', 'type' => 'string', 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3'],
],
],
],
@@ -5694,81 +4457,69 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0bc1e96d17091734639835114e12c8\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"null\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": {\\n \\"correction\\": \\"I am you.\\",\\n \\"analysis\\": \\"主语 \\\\\\\\\\\\\\"I\\\\\\\\\\\\\\" 后应跟动词 \\\\\\\\\\\\\\"am\\\\\\\\\\\\\\" 而不是 \\\\\\\\\\\\\\"are\\\\\\\\\\\\\\"。\\",\\n \\"correctionStatus\\": \\"Has_Error\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '获取用户回复内容的语法检测的结果',
- ],
- 'ExecuteTextbookAssistantRetryConversation' => [
- 'summary' => '对话重试',
- 'path' => '/api/v1/textbookAssistant/dialogue/RetryConversation',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A5E9849-A2F0-551D-A7D8-1A8118557BAB\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"expire\\": 5400,\\n \\"authToken\\": \\"tc_197bf5bb81889cc79eb51ae9b8c0cea3\\"\\n }\\n}","type":"json"}]',
+ 'title' => '获取英语教材式AI老师功能使用授权码',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:GetTextbookAssistantToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTextbookAssistantArticleDetails' => [
+ 'summary' => '批量获取文章详情',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/ListArticleDetails',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '262152',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '262952',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -5780,33 +4531,12 @@
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'scenario' => [
- 'description' => '选择场景。SYNC:同步练习,EXPAND:拓展练习',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'SYNC',
- 'enum' => [
- 'SYNC',
- 'EXPAND',
- ],
- ],
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'assistant' => [
- 'description' => 'AI老师生成消息的编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6788e0b4b54c5268c1b78638',
- ],
- 'authToken' => [
- 'description' => '接口调用授权码,可以通过"英语教材式AI老师功能使用授权码"接口获取。',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874',
+ 'authToken' => ['description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
+ 'articleIdList' => [
+ 'description' => '文章ID列表',
+ 'type' => 'array',
+ 'items' => ['description' => '文章ID', 'type' => 'string', 'required' => false, 'example' => '0c05700d4d9411efbe6e0c42a106bb02'],
+ 'required' => false,
],
],
'required' => false,
@@ -5820,65 +4550,104 @@
'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => 'Id of the request',
- 'type' => 'string',
- 'example' => '2F2ABF4B-A4F6-5EC7-B287-7EF5B156F1ED',
- ],
- 'success' => [
- 'description' => '调用是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => 'null',
- ],
- 'errCode' => [
- 'description' => '错误码',
- 'type' => 'string',
- 'example' => '0',
- ],
- 'httpStatusCode' => [
- 'description' => 'HTTP状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**:成功'."\n"
+ ."\n"
+ .'- **false**:失败', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'description' => '返回数据对象',
- 'type' => 'object',
- 'properties' => [
- 'chatId' => [
- 'description' => '本轮对话的编号',
- 'type' => 'string',
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'assistant' => [
- 'description' => 'AI老师回复消息编号',
- 'type' => 'string',
- 'example' => '6788e0b4b54c5268c1b78638',
- ],
- 'user' => [
- 'description' => '用户回复消息编号',
- 'type' => 'string',
- 'example' => '6788e0b45bdfc807f077a5a1',
- ],
- 'result' => [
- 'description' => '结果数据',
- 'type' => 'object',
- 'properties' => [
- 'englishResult' => [
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => 'Good evening! From the book, how does Mike Black introduce himself?',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'articleId' => ['description' => '文章ID', 'type' => 'string', 'example' => '0c05700d4d9411efbe6e0c42a106bb02'],
+ 'target' => ['description' => '练习目标', 'type' => 'string', 'example' => '1.能够在自我介绍时运用句型“What\'s your name? My name is/I‘m...”进行询问及回答。\\n2.能够和新朋友运用句型“Nice to meet you(too).”进行问候。'],
+ 'questionList' => [
+ 'description' => '问答数据',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '问题列表',
+ 'type' => 'object',
+ 'properties' => [
+ 'question' => ['description' => '问题内容。', 'type' => 'string', 'example' => 'From the book, how does Mike Black introduce himself?'],
+ 'questionTranslate' => ['description' => '问题内容翻译的结果', 'type' => 'string', 'example' => '根据文章,迈克·布莱克是如何介绍自己的?'],
+ 'answer' => ['description' => '问题对应的答案', 'type' => 'string', 'example' => 'I\'m Mike Black'],
+ ],
+ ],
+ ],
+ 'sceneList' => [
+ 'description' => '场景列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '场景列表数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'sceneId' => ['description' => '场景Id', 'type' => 'string', 'example' => '38cddd70509911efbe6e0c42a106bb02'],
+ 'scene' => ['description' => '场景描述', 'type' => 'string', 'example' => 'In the park, you introduce yourself to John and ask his name.'],
+ 'sceneImageList' => [
+ 'description' => '当前场景相关图片',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png'],
+ ],
+ 'sceneTranslate' => ['type' => 'string', 'description' => ''],
+ ],
+ ],
+ ],
+ 'theme' => [
+ 'description' => '主题信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'themeName' => ['description' => '主题名称', 'type' => 'string', 'example' => '自我认知与提升'],
+ 'themeTranslate' => ['description' => '主题名称翻译内容', 'type' => 'string', 'example' => 'Self-awareness, self-management, self-improvement'],
+ 'themeImageList' => [
+ 'description' => '当前主题相关图片',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png'],
+ ],
+ ],
+ ],
+ 'topic' => [
+ 'description' => '话题信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'topicName' => ['description' => '话题名称', 'type' => 'string', 'example' => '打招呼与自我介绍'],
+ 'topicTranslate' => ['description' => '话题内容翻译', 'type' => 'string', 'example' => 'Greetings and self-introduction'],
+ 'topicImageList' => [
+ 'description' => '当前话题相关图片',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png'],
+ ],
],
- 'chineseResult' => [
- 'description' => 'AI老师的中文回复',
- 'type' => 'string',
- 'example' => '根据文章,迈克·布莱克是如何介绍自己的?',
+ ],
+ 'sentenceList' => [
+ 'description' => '句子信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '句子信息详情',
+ 'type' => 'object',
+ 'properties' => [
+ 'sentenceId' => ['description' => '句子Id', 'type' => 'string', 'example' => '4de677d2509811efbe6e0c42a106bb02'],
+ 'sentenceText' => ['description' => '句子文本信息', 'type' => 'string', 'example' => 'I\'m Mike Black'],
+ 'sentenceAnalysis' => ['description' => '句子分析,释义', 'type' => 'string', 'example' => '主语 + be动词(am/is/are) + 姓名.'],
+ ],
+ ],
+ ],
+ 'wordList' => [
+ 'description' => '单词信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '单词信息详情',
+ 'type' => 'object',
+ 'properties' => [
+ 'wordId' => ['description' => '单词id', 'type' => 'string', 'example' => 'a94df134ed8c11eebe6e0c42a106bb02'],
+ 'wordText' => ['description' => '单词文本', 'type' => 'string', 'example' => 'nice'],
+ 'wordAnalysis' => ['description' => '单词释义', 'type' => 'string', 'example' => '令人愉快的;友好的'],
+ ],
],
],
],
@@ -5891,85 +4660,68 @@
'schema' => [
'type' => 'object',
'properties' => [
- 'RequestId' => [
- 'type' => 'string',
- ],
- 'Success' => [
- 'type' => 'string',
- ],
- 'Message' => [
- 'type' => 'string',
- ],
- 'Synchro' => [
- 'type' => 'string',
- ],
- 'Data' => [
- 'type' => 'string',
- ],
- 'Code' => [
- 'type' => 'string',
- ],
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'AuthAction' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalDisplayName' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalOwnerId' => [
- 'type' => 'string',
- ],
- 'AuthPrincipalType' => [
- 'type' => 'string',
- ],
- 'EncodedDiagnosticMessage' => [
- 'type' => 'string',
- ],
- 'NoPermissionType' => [
- 'type' => 'string',
- ],
- 'PolicyType' => [
- 'type' => 'string',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"articleId\\": \\"0c05700d4d9411efbe6e0c42a106bb02\\",\\n \\"target\\": \\"1.能够在自我介绍时运用句型“What\'s your name? My name is/I‘m...”进行询问及回答。\\\\\\\\n2.能够和新朋友运用句型“Nice to meet you(too).”进行问候。\\",\\n \\"questionList\\": [\\n {\\n \\"question\\": \\"From the book, how does Mike Black introduce himself?\\",\\n \\"questionTranslate\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\",\\n \\"answer\\": \\"I\'m Mike Black\\"\\n }\\n ],\\n \\"sceneList\\": [\\n {\\n \\"sceneId\\": \\"38cddd70509911efbe6e0c42a106bb02\\",\\n \\"scene\\": \\"In the park, you introduce yourself to John and ask his name.\\",\\n \\"sceneImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ],\\n \\"sceneTranslate\\": \\"\\"\\n }\\n ],\\n \\"theme\\": {\\n \\"themeName\\": \\"自我认知与提升\\",\\n \\"themeTranslate\\": \\"Self-awareness, self-management, self-improvement\\",\\n \\"themeImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"topic\\": {\\n \\"topicName\\": \\"打招呼与自我介绍\\",\\n \\"topicTranslate\\": \\"Greetings and self-introduction\\",\\n \\"topicImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"sentenceList\\": [\\n {\\n \\"sentenceId\\": \\"4de677d2509811efbe6e0c42a106bb02\\",\\n \\"sentenceText\\": \\"I\'m Mike Black\\",\\n \\"sentenceAnalysis\\": \\"主语 + be动词(am/is/are) + 姓名.\\"\\n }\\n ],\\n \\"wordList\\": [\\n {\\n \\"wordId\\": \\"a94df134ed8c11eebe6e0c42a106bb02\\",\\n \\"wordText\\": \\"nice\\",\\n \\"wordAnalysis\\": \\"令人愉快的;友好的\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取文章详情',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-21T09:34:12.000Z', 'description' => '响应参数发生变更'],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"2F2ABF4B-A4F6-5EC7-B287-7EF5B156F1ED\\",\\n \\"success\\": true,\\n \\"errMessage\\": \\"null\\",\\n \\"errCode\\": \\"0\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"chatId\\": \\"6788e0b475a4631ffc626722\\",\\n \\"assistant\\": \\"6788e0b4b54c5268c1b78638\\",\\n \\"user\\": \\"6788e0b45bdfc807f077a5a1\\",\\n \\"result\\": {\\n \\"englishResult\\": \\"Good evening! From the book, how does Mike Black introduce himself?\\",\\n \\"chineseResult\\": \\"根据文章,迈克·布莱克是如何介绍自己的?\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '重新生成AI老师的提问内容',
- ],
- 'ExecuteAITeacherEnglishParaphraseChatMessage' => [
- 'summary' => '英语答疑',
- 'path' => '/pop/api/v1/intelligentAgent/englishParaphrase/chatMessage',
- 'methods' => [
- 'post',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantSceneDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTextbookAssistantArticles' => [
+ 'summary' => '获取文章列表。',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/ListArticles',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'produces' => [],
- 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'riskType' => 'none',
- 'abilityTreeCode' => '264496',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'list',
+ 'abilityTreeCode' => '261984',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -5978,66 +4730,12 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求体对象。',
'type' => 'object',
'properties' => [
- 'questionInfo' => [
- 'title' => '题目信息',
- 'description' => '题目信息',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'How to inquire about the price',
- ],
- 'grade' => [
- 'title' => '年级信息',
- 'description' => '年级',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '3',
- ],
- 'userAnswer' => [
- 'title' => '要求回答内容',
- 'description' => '问题的正确答案',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'How much is this?',
- ],
- 'questionId' => [
- 'title' => '题干ID',
- 'description' => '题目唯一标识',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxxxxxxx',
- ],
- 'content' => [
- 'title' => '用户输入内容',
- 'description' => '用户输入内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'How much is this?',
- ],
- 'chatId' => [
- 'title' => '本次会话ID',
- 'description' => '本次会话ID',
- 'type' => 'string',
- 'required' => false,
- 'example' => '6788e0b475a4631ffc626722',
- ],
- 'userId' => [
- 'title' => '用户名',
- 'description' => '用户名',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxxxxx',
- ],
- 'responseMode' => [
- 'title' => '数据响应类型',
- 'description' => '数据响应方式',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'sreaming',
- ],
+ 'directoryId' => ['description' => '目录ID。可以通过获取教材目录接口获取', 'type' => 'string', 'required' => true, 'example' => '90aa861b4d9311efbe6e0c42a106bb02'],
+ 'authToken' => ['description' => '消息临时授权码,可以通过获取服务窗消息发送授权码接口获取。'."\n"
+ ."\n", 'type' => 'string', 'required' => true, 'example' => 'tc_a893b8492c4be046cbc906c566aeb8c9'],
],
'required' => false,
],
@@ -6047,75 +4745,105 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应体',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'event' => [
- 'title' => 'Id of the request',
- 'description' => '事件',
- 'type' => 'string',
- 'example' => 'message',
- ],
- 'content' => [
- 'description' => '事件对应的内容信息',
- 'type' => 'string',
- 'example' => 'how',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '70412360-4272-571A-827D-84C2C07C450F'],
+ 'success' => [
+ 'description' => '接口调用是否成功。'."\n"
+ .'- **true**:成功'."\n"
+ ."\n"
+ .'- **false**:失败',
+ 'type' => 'boolean',
+ 'enumValueTitles' => [],
+ 'example' => 'true',
],
- 'requestId' => [
- 'description' => '请求ID,请求错误时会返回对应内容',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
+ 'errCode' => ['description' => '错误码'."\n"
+ .'* 正确:errCode = 0'."\n"
+ .'* 错误:errCode > 0,具体错误对应的错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['description' => 'HTTP 状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'description' => '请求返回结果。',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'articleId' => ['description' => '文章ID', 'type' => 'string', 'example' => '0c05700d4d9411efbe6e0c42a106bb02'],
+ ],
+ 'description' => '',
+ ],
],
],
],
],
- 401 => [
+ 403 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'success' => [
- 'type' => 'string',
- ],
- 'errCode' => [
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'type' => 'string',
- ],
- 'httpStatusCode' => [
- 'type' => 'string',
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'accessDeniedDetail' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"how\\",\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\"\\n}","type":"json"}]',
- 'title' => '英语答疑',
- ],
- 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun' => [
- 'summary' => '英语作文辅导',
- 'path' => '/pop/api/v1/intelligentAgent/englishCompositionTutoring/workflowRun',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"70412360-4272-571A-827D-84C2C07C450F\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"articleId\\": \\"0c05700d4d9411efbe6e0c42a106bb02\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取英语教材的文章列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
- 'sse',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantArticles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTextbookAssistantBookDirectories' => [
+ 'summary' => '获取书本下的目录信息。',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/ListBookDirectories',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'write',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
- 'abilityTreeCode' => '264493',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '261983',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
'tenantRelevance' => 'tenant',
],
'parameters' => [
@@ -6124,83 +4852,21 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求体对象。',
'type' => 'object',
'properties' => [
- 'essayOutline' => [
- 'title' => '大纲',
- 'description' => '作文大纲',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Title: The Importance of Reading'."\n"
- .'I. Introduction'."\n"
- .'II. Body'."\n"
- .'III. Conclusion',
- 'enum' => [],
- ],
- 'essayRequirements' => [
- 'title' => '要求',
- 'description' => '作文要求(必填)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'No less than 100 words',
- ],
- 'essayTopic' => [
- 'title' => '主题',
- 'description' => '作文主题(必填)',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Discuss what to eat',
- ],
- 'essayType' => [
- 'title' => '输出内容类型,essay:文章,outline:大纲',
- 'description' => '作文类型(必填)'."\n"
- ."\n"
- .'outline:大纲'."\n"
- ."\n"
- .'essay:文章',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'essay',
- 'enum' => [
- 'essay',
- 'outline',
- ],
- ],
- 'essayWordCount' => [
- 'title' => '要求字数',
- 'description' => '要求字数',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '100',
- ],
- 'grade' => [
- 'title' => '年级',
- 'description' => '年级',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => true,
- 'example' => '3',
- ],
- 'responseMode' => [
- 'title' => '数据响应方式',
- 'description' => '数据响应方式',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'streaming',
- 'default' => 'streaming',
- 'enum' => [
- 'streaming',
- ],
- ],
- 'userId' => [
- 'title' => '用户名',
- 'description' => '用户名',
+ 'bookId' => ['description' => '书本编号Id,可以通过”获取英语教材的书本“接口中获取', 'type' => 'string', 'required' => true, 'example' => '231698'],
+ 'scenario' => [
+ 'description' => '选择场景数据。SYNC:同步练习,EXPAND:拓展练习',
'type' => 'string',
'required' => true,
- 'example' => 'xxxxxxx',
+ 'docRequired' => true,
+ 'enumValueTitles' => ['EXPAND' => 'EXPAND:拓展练习', 'ALL' => 'ALL:全部', 'SYNC' => 'SYNC:同步练习'],
+ 'example' => 'SYNC',
+ 'default' => 'SYNC',
+ 'enum' => ['SYNC', 'EXPAND', 'ALL'],
],
+ 'authToken' => ['description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
],
'required' => false,
],
@@ -6210,76 +4876,181 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应体',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求ID,请求错误时会返回对应内容',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'event' => [
- 'description' => '事件',
- 'type' => 'string',
- 'example' => 'message',
- ],
- 'content' => [
- 'description' => '事件对应的内容信息',
- 'type' => 'string',
- 'example' => 'hi',
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0A5E9849-A2F0-551D-A7D8-1A8118557BAB'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'B_USER_NOT_FOUND_EXCEPTION'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '用户不存在'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'description' => '返回数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'editionInfo' => [
+ 'description' => '版次信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'bookId' => ['description' => '书本编号Id', 'type' => 'string', 'example' => '55857'],
+ 'isbn' => ['description' => '国际标准书号', 'type' => 'string', 'example' => '9787544413695'],
+ 'edition' => ['description' => '版次', 'type' => 'string', 'example' => '2010-1(2)'],
+ 'impression' => ['description' => '印次', 'type' => 'string', 'example' => '2019-1(10)'],
+ 'publisher' => ['description' => '出版社', 'type' => 'string', 'example' => '人民教育出版社'],
+ 'version' => ['description' => '教材版本', 'type' => 'string', 'example' => '人教版'],
+ 'subject' => ['description' => '学科', 'type' => 'string', 'example' => 'ENGLISH'],
+ 'grade' => ['description' => '年级,取值范围1-9,和年级level对应', 'type' => 'string', 'example' => '3'],
+ 'bookVolume' => ['description' => '册次,0:全一册,1:上册,2:下册', 'type' => 'string', 'example' => '1'],
+ ],
+ ],
+ 'directoryTree' => [
+ 'description' => '目录数据结构',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'directoryId' => ['description' => '目录ID', 'type' => 'string', 'example' => '05758807ed8e11eebe6e0c42a106bb02'],
+ 'directoryName' => ['description' => '目录名称', 'type' => 'string', 'example' => '2 Jobs'],
+ 'topic' => [
+ 'description' => '对话主题',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'labelId' => ['description' => '标签ID', 'type' => 'string', 'example' => '1323'],
+ 'labelName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '身边事物环境'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'unit' => [
+ 'description' => '单元信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'directoryId' => ['description' => '目录ID', 'type' => 'string', 'example' => '05758807ed8e11eebe6e0c42a106bb02'],
+ 'directoryName' => ['description' => '目录名称', 'type' => 'string', 'example' => 'unit 2'],
+ 'topic' => [
+ 'description' => '话题名称',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'labelId' => ['description' => '标签id', 'type' => 'string', 'example' => '1326'],
+ 'labelName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '自我介绍'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'section' => [
+ 'description' => '句子信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'directoryId' => ['description' => '目录ID', 'type' => 'string', 'example' => '05758807ed8e11eebe6e0c42a106bb02'],
+ 'directoryName' => ['description' => '目录名称', 'type' => 'string', 'example' => 'section 2'],
+ 'topic' => [
+ 'description' => '主题',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '主题相关信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'labelId' => ['description' => '标签ID', 'type' => 'string', 'example' => '1329'],
+ 'labelName' => ['description' => '标签名称。', 'type' => 'string', 'example' => '自我介绍'],
+ ],
+ ],
+ ],
+ 'children' => ['description' => '可能存在的子元素,兼容数据使用,不一定存在', 'type' => 'any', 'example' => '可能存在的子元素,兼容数据使用,不一定存在'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
+ ],
],
],
],
],
- 401 => [
+ 403 => [
'schema' => [
'type' => 'object',
'properties' => [
- 'success' => [
- 'type' => 'string',
- ],
- 'errCode' => [
- 'type' => 'string',
- ],
- 'errMsg' => [
- 'type' => 'string',
- ],
- 'httpStatusCode' => [
- 'type' => 'string',
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'accessDeniedDetail' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"hi\\"\\n}","type":"json"}]',
- 'title' => '英语作文生成',
- ],
- 'AITeacherSyncPracticeTaskGenerate' => [
- 'summary' => '同步基础练主要面向有标准答案的对话任务,虽然该模式允许用户和标准答案有一定的区别或偏差,但AI会相对严格的要求用户使用标准答案回复问题,',
- 'path' => '/api/v1/aiteacher/syncPractice/generateTask',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A5E9849-A2F0-551D-A7D8-1A8118557BAB\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"editionInfo\\": {\\n \\"bookId\\": \\"55857\\",\\n \\"isbn\\": \\"9787544413695\\",\\n \\"edition\\": \\"2010-1(2)\\",\\n \\"impression\\": \\"2019-1(10)\\",\\n \\"publisher\\": \\"人民教育出版社\\",\\n \\"version\\": \\"人教版\\",\\n \\"subject\\": \\"ENGLISH\\",\\n \\"grade\\": \\"3\\",\\n \\"bookVolume\\": \\"1\\"\\n },\\n \\"directoryTree\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"2 Jobs\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1323\\",\\n \\"labelName\\": \\"身边事物环境\\"\\n }\\n ],\\n \\"unit\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"unit 2\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1326\\",\\n \\"labelName\\": \\"自我介绍\\"\\n }\\n ],\\n \\"section\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"section 2\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1329\\",\\n \\"labelName\\": \\"自我介绍\\"\\n }\\n ],\\n \\"children\\": \\"可能存在的子元素,兼容数据使用,不一定存在\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '获取英语教材的书本目录',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-21T09:34:12.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantBookDirectories',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListTextbookAssistantBooks' => [
+ 'summary' => '获取包含年级下的书本列表。',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/ListBooks',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
+ 'operationType' => 'list',
'riskType' => 'none',
'chargeType' => 'paid',
- 'abilityTreeCode' => '258598',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'abilityTreeCode' => '261982',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
@@ -6287,80 +5058,16 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求体对象。',
'type' => 'object',
'properties' => [
- 'userId' => [
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6440xxxxxxxxxx5fafc98c421'."\n",
- ],
- 'grade' => [
- 'description' => '年级',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 3 => '3年级',
- '4年级',
- '5年级',
- '6年级',
- '7年级',
- '8年级',
- '9年级',
- '10年级',
- '11年级',
- '12年级',
- '大学',
- ],
- 'example' => '13'."\n",
- ],
- 'textbook' => [
- 'description' => '教材名',
- 'type' => 'string',
- 'required' => false,
- 'example' => '英语(基础模块)修订版'."\n",
- ],
- 'topic' => [
- 'description' => '对话主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'talk about your dream job.'."\n",
- ],
- 'learningObject' => [
- 'description' => '学习目标',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Understanding unique professions such as dog walkers, hotel test sleepers, and food tasters, including their job responsibilities and the benefits or challenges associated with each role.'."\n",
- ],
- 'textContent' => [
- 'description' => '用于生成问题的参考文章',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Dog walker Dog walking, as a profession, originated in the US. Some may think that it\'s a perfect job, because dog walkers won\'t be imprisoned in an office. But it\'s actually manual labour. At their busiest, dog walkers may have more than ten dogs to take care of in a day. Hotel test sleeper A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining and other services of hotels, in order to provide evaluations and guides for travelers. Hotel test sleepers don\'t need to punch in for work and they get about ten thousand yuan as income every month. What a comfortable job! Food taster In ancient times, a food taster was a person who tasted foods (or drinks) to be served to someone else, to confirm that it was safe to eat. But now, those working as food tasters just get to taste various new foods and drinks aimed at specific regions across the world. They then give their opinions on these products to the companies and suggest improvements.',
- ],
- 'keySentences' => [
- 'description' => '重点学习句子集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '重点学习句子',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining, and other services of hotels.',
- ],
- 'required' => false,
- ],
- 'keyWords' => [
- 'description' => '重点学习单词集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '重点学习单词',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'responsibility'."\n",
- ],
- 'required' => false,
- ],
+ 'bookId' => ['description' => '书本编号ID', 'type' => 'string', 'required' => false, 'example' => '231698'],
+ 'grade' => ['description' => '年级,取值范围1-9,和年级level对应', 'type' => 'string', 'required' => false, 'example' => '1'."\n"],
+ 'volume' => ['description' => '册次,0:全一册,1:上册,2:下册', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'version' => ['description' => '教材版本', 'type' => 'string', 'required' => false, 'example' => '人教版'],
+ 'page' => ['description' => '页码', 'type' => 'string', 'required' => false, 'example' => '1'],
+ 'maxResults' => ['description' => '每页最大条目数,最大值20。', 'type' => 'string', 'required' => false, 'example' => '20'],
+ 'authToken' => ['description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => true, 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3'],
],
'required' => false,
],
@@ -6370,63 +5077,47 @@
200 => [
'schema' => [
'title' => 'Schema of Response',
- 'description' => '响应结构体',
+ 'description' => 'Schema of Response',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'."\n",
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR'."\n",
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误'."\n",
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B695B377-7029-5805-9DE2-1AAE06C1BF6B'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'B_USER_NOT_FOUND_EXCEPTION'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '用户不存在'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '数据对象',
+ 'description' => '返回数据对象。',
'type' => 'object',
'properties' => [
- 'taskType' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'example' => 'textbook_question_answering',
+ 'paginationData' => [
+ 'description' => '分页数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'totalCount' => ['description' => '全量数据的条数', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'maxResults' => ['description' => '本次查询单页的数据条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'currentPage' => ['description' => '当前页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ ],
],
- 'taskContent' => [
- 'description' => '问答对集合',
+ 'bookList' => [
+ 'description' => '书本列表信息',
'type' => 'array',
'items' => [
- 'description' => '问答对',
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'description' => 'AI老师提问',
- 'type' => 'string',
- 'example' => 'Why might some people think dog walking is a great job?'."\n",
- ],
- 'user' => [
- 'description' => '学生回答',
- 'type' => 'string',
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.'."\n",
- ],
+ 'bookId' => ['description' => '书本编号Id', 'type' => 'string', 'example' => '231698'],
+ 'isbn' => ['description' => '国际标准书号', 'type' => 'string', 'example' => '9787107382505'],
+ 'edition' => ['description' => '版次', 'type' => 'string', 'example' => '2024-7(1)'],
+ 'impression' => ['description' => '印次', 'type' => 'string', 'example' => '2024-7(1)'],
+ 'publisher' => ['description' => '出版社', 'type' => 'string', 'example' => '人民教育出版社'],
+ 'version' => ['description' => '教材版本', 'type' => 'string', 'example' => '人教版'],
+ 'subject' => ['description' => '学科', 'type' => 'string', 'example' => 'ENGLISH'],
+ 'grade' => ['description' => '年级,取值范围1-9,对应年级level', 'type' => 'string', 'example' => '3'],
+ 'volume' => ['description' => '册次,0:全一册,1:上册,2:下册', 'type' => 'string', 'example' => '0'],
+ 'author' => ['description' => '作者信息', 'type' => 'string', 'example' => '吴欣'],
+ 'bookName' => ['description' => '书本名称', 'type' => 'string', 'example' => 'K12英语-人教版PEP三起-三年级上册'],
+ 'coverImage' => ['description' => '书本封面', 'type' => 'string', 'example' => 'null'],
],
+ 'description' => '',
],
],
],
@@ -6434,35 +5125,74 @@
],
],
],
+ 403 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'accessDeniedDetail' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'description' => '',
+ ],
+ ],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
- ],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\\\n\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\\\n\\",\\n \\"errMessage\\": \\"未知错误\\\\n\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskType\\": \\"textbook_question_answering\\",\\n \\"taskContent\\": [\\n {\\n \\"assistant\\": \\"Why might some people think dog walking is a great job?\\\\n\\",\\n \\"user\\": \\"They think it\'s great because they won\'t be stuck in an office.\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
- 'title' => '同步练对话任务生成',
- ],
- 'ExecuteAITeacherSyncDialogue' => [
- 'summary' => '进行同步练对话。',
- 'path' => '/api/v1/aiteacher/syncPractice/executeSyncTraining',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"B695B377-7029-5805-9DE2-1AAE06C1BF6B\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"paginationData\\": {\\n \\"totalCount\\": 200,\\n \\"maxResults\\": 20,\\n \\"currentPage\\": 1\\n },\\n \\"bookList\\": [\\n {\\n \\"bookId\\": \\"231698\\",\\n \\"isbn\\": \\"9787107382505\\",\\n \\"edition\\": \\"2024-7(1)\\",\\n \\"impression\\": \\"2024-7(1)\\",\\n \\"publisher\\": \\"人民教育出版社\\",\\n \\"version\\": \\"人教版\\",\\n \\"subject\\": \\"ENGLISH\\",\\n \\"grade\\": \\"3\\",\\n \\"volume\\": \\"0\\",\\n \\"author\\": \\"吴欣\\",\\n \\"bookName\\": \\"K12英语-人教版PEP三起-三年级上册\\",\\n \\"coverImage\\": \\"null\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
+ 'title' => '获取英语教材的书本',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantBooks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'ListTextbookAssistantGradeVolumes' => [
+ 'summary' => '获取拥有英语教材资源的年级列表。',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/ListGradeVolumes',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'create',
- 'abilityTreeCode' => '259253',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
- 'tenantRelevance' => 'publicInformation',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '261927',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
@@ -6470,227 +5200,131 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '请求body参数',
+ 'description' => '请求体对象。',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录结构体',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'assistant' => 'AI ',
- 'user' => '用户',
- ],
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用。'."\n"
- .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
- .'跑题超过两次,取值会强制置为true,用于强制切换任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
+ 'scenario' => [
+ 'description' => '使用场景。SYNC:同步练习,EXPAND:拓展练习',
+ 'type' => 'string',
+ 'required' => true,
+ 'example' => 'SYNC',
+ 'enum' => ['SYNC', 'EXPAND'],
],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
+ 'authToken' => ['description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => false, 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F3B1AAF2-3041-5AA7-A352-BD5F998FA465'],
+ 'success' => ['description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => '0'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['description' => 'HTTP状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '返回数据对象',
+ 'description' => '返回数据对象',
'type' => 'array',
'items' => [
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
- ],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'textbookVersion' => ['type' => 'string', 'example' => '人教版', 'description' => ''],
+ 'gradeVolumes' => [
+ 'title' => '年级册次数据信息',
+ 'description' => '年级册次数据信息',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'volume' => ['title' => '册次,0:全一册,1:上册,2:下册', 'description' => '册次,0:全一册,1:上册,2:下册', 'type' => 'string', 'example' => '1'],
+ 'grade' => ['title' => '年级,取值范围 1-9,对应年级 level', 'description' => '年级,取值范围 1-9,对应年级 level', 'type' => 'string', 'example' => '3'],
+ ],
+ 'description' => '',
+ ],
],
],
- 'required' => true,
- ],
- 'required' => true,
- ],
- 'languageCode' => [
- 'title' => '语言编码',
- 'description' => '语言编码',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-us' => '美式英语',
- 'en-gb' => '英式英语',
+ 'description' => '',
],
- 'example' => 'en-gb',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
],
],
- 'required' => false,
],
],
- ],
- 'responses' => [
- 200 => [
+ 403 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AITeacherSyncBasicTrainDTO>',
- 'description' => '响应结果',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '数据对象',
- 'description' => '数据对象',
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Sychro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'accessDeniedDetail' => [
'type' => 'object',
'properties' => [
- 'englishResult' => [
- 'title' => 'AI老师的英文回复',
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => 'Thanks, Lily. Do you like meat, Lily?',
- ],
- 'isFinish' => [
- 'title' => '是否完成对话',
- 'description' => '是否完成对话',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'questionIndex' => [
- 'title' => '当前作答的问题编号',
- 'description' => '当前作答的问题编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
],
- 'example' => '[]',
+ 'description' => '',
],
],
+ 'description' => '',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"isFinish\\": true,\\n \\"isOnTopic\\": true,\\n \\"questionIndex\\": 2\\n }\\n}","type":"json"}]',
- 'title' => '执行同步练',
- ],
- 'ExecuteAITeacherSyncDialogueTranslate' => [
- 'summary' => '同步练语境翻译。',
- 'path' => '/api/v1/aiteacher/syncPractice/translate',
- 'methods' => [
- 'post',
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F3B1AAF2-3041-5AA7-A352-BD5F998FA465\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"textbookVersion\\": \\"人教版\\",\\n \\"gradeVolumes\\": [\\n {\\n \\"volume\\": \\"1\\",\\n \\"grade\\": \\"3\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取拥有英语教材资源的年级列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-16T03:35:13.000Z', 'description' => '响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantGradeVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ListTextbookAssistantSceneDetails' => [
+ 'summary' => '获取文章内容详情',
+ 'path' => '/api/v1/textbookAssistant/teachingResource/ListSceneDetails',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '259935',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'paid',
+ 'abilityTreeCode' => '262951',
+ 'abilityTreeNodes' => ['FEATUREaioralKM5ZTF'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
@@ -6701,308 +5335,392 @@
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录集合',
+ 'authToken' => ['description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', 'type' => 'string', 'required' => false, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'],
+ 'sceneIdList' => [
+ 'description' => '场景ID列表',
'type' => 'array',
- 'items' => [
- 'description' => '对话记录结构体',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => true,
- ],
+ 'items' => ['description' => '场景ID', 'type' => 'string', 'required' => false, 'example' => '38c41b7b509911efbe6e0c42a106bb02'],
'required' => false,
],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'Schema of Response',
+ 'description' => 'Schema of Response',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['description' => '接口调用是否成功。'."\n"
+ .'- **true**:成功'."\n"
+ ."\n"
+ .'- **false**:失败', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['description' => '错误码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['description' => 'HTTP 状态码。', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'description' => '返回数据对象',
'type' => 'array',
'items' => [
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
+ 'sceneId' => ['description' => '场景Id', 'type' => 'string', 'example' => '38c41b7b509911efbe6e0c42a106bb02'],
+ 'target' => ['description' => '练习目标', 'type' => 'string', 'example' => '""'],
+ 'scene' => ['description' => '场景描述', 'type' => 'string', 'example' => 'At school, Carl sees a photo and asks you about your family.'],
+ 'sceneImageList' => [
+ 'description' => '当前场景相关图片',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png'],
],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
+ 'sceneTaskList' => [
+ 'description' => '场景任务列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '任务信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'sceneTask' => ['description' => '场景任务描述', 'type' => 'string', 'example' => 'Say that this is your dad\'s brother.'],
+ 'sceneTaskTranslate' => ['description' => '场景任务描述释义', 'type' => 'string', 'example' => '说这是你爸爸的兄弟。'],
+ ],
+ ],
],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
+ 'theme' => [
+ 'description' => '主题信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'themeName' => ['description' => '主题名称', 'type' => 'string', 'example' => '家庭生活'],
+ 'themeTranslate' => ['description' => '主题名称翻译内容', 'type' => 'string', 'example' => 'Family and family life'],
+ 'themeImageList' => [
+ 'description' => '当前主题相关图片',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png'],
+ ],
+ ],
],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'topic' => [
+ 'description' => '话题信息',
+ 'type' => 'object',
+ 'properties' => [
+ 'topicName' => ['description' => '话题名称', 'type' => 'string', 'example' => '介绍家人'],
+ 'topicTranslate' => ['description' => '话题内容翻译', 'type' => 'string', 'example' => 'Introducing family members'],
+ 'topicImageList' => [
+ 'description' => '当前话题相关图片',
+ 'type' => 'array',
+ 'items' => ['description' => '图片地址', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png'],
+ ],
+ ],
],
+ 'sentenceList' => [
+ 'description' => '句子信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '句子详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'sentenceId' => ['description' => '句子编号ID', 'type' => 'string', 'example' => 'a774c6d09c4511eebe6e0c42a106bb02'],
+ 'sentenceText' => ['description' => '句子文本信息', 'type' => 'string', 'example' => 'Is this your sister?'],
+ 'sentenceAnalysis' => ['description' => '句子分析,释义', 'type' => 'string', 'example' => 'Is + this + your + 家庭成员?'],
+ ],
+ ],
+ ],
+ 'wordList' => [
+ 'description' => '单词信息列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '单词详情。',
+ 'type' => 'object',
+ 'properties' => [
+ 'wordId' => ['description' => '单词id', 'type' => 'string', 'example' => 'a94c3337ed8c11eebe6e0c42a106bb02'],
+ 'wordText' => ['description' => '单词文本', 'type' => 'string', 'example' => 'family'],
+ 'wordAnalysis' => ['description' => '单词释义', 'type' => 'string', 'example' => '家;家庭'],
+ ],
+ ],
+ ],
+ 'roleList' => [
+ 'description' => '角色列表',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'roleName' => ['description' => '角色名称', 'type' => 'string', 'example' => 'Carl'],
+ 'roleNameTranslate' => ['description' => '角色名称翻译结果', 'type' => 'string', 'example' => 'Carl'],
+ 'introduction' => ['description' => '角色介绍', 'type' => 'string', 'example' => 'Carl, a curious boy'],
+ 'introductionTranslate' => ['description' => '角色介绍翻译结果', 'type' => 'string', 'example' => 'Carl,一个好奇的男孩'],
+ 'promoting' => ['description' => '角色引导文本', 'type' => 'string', 'example' => 'Hi Noah, who is that in the photo?'],
+ 'promotingTranslate' => ['description' => '角色引导文本翻译结果', 'type' => 'string', 'example' => '嗨 Noah,照片里的人是谁?'],
+ 'roleType' => ['description' => '角色类型(0为提问者AI,1为回答者)', 'type' => 'string', 'example' => '0'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'sceneTranslate' => ['type' => 'string', 'description' => ''],
],
- 'required' => false,
],
- 'required' => true,
],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
+ ],
+ ],
+ ],
+ 403 => [
+ 'schema' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'RequestId' => ['type' => 'string', 'description' => ''],
+ 'Message' => ['type' => 'string', 'description' => ''],
+ 'Synchro' => ['type' => 'string', 'description' => ''],
+ 'Data' => ['type' => 'string', 'description' => ''],
+ 'Code' => ['type' => 'string', 'description' => ''],
+ 'Success' => ['type' => 'string', 'description' => ''],
+ 'accessDeniedDetail' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'AuthAction' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => ''],
+ 'AuthPrincipalType' => ['type' => 'string', 'description' => ''],
+ 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => ''],
+ 'NoPermissionType' => ['type' => 'string', 'description' => ''],
+ 'PolicyType' => ['type' => 'string', 'description' => ''],
+ ],
+ 'description' => '',
],
],
- 'required' => false,
+ 'description' => '',
],
],
],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"sceneId\\": \\"38c41b7b509911efbe6e0c42a106bb02\\",\\n \\"target\\": \\"\\\\\\"\\\\\\"\\",\\n \\"scene\\": \\"At school, Carl sees a photo and asks you about your family.\\",\\n \\"sceneImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ],\\n \\"sceneTaskList\\": [\\n {\\n \\"sceneTask\\": \\"Say that this is your dad\'s brother.\\",\\n \\"sceneTaskTranslate\\": \\"说这是你爸爸的兄弟。\\"\\n }\\n ],\\n \\"theme\\": {\\n \\"themeName\\": \\"家庭生活\\",\\n \\"themeTranslate\\": \\"Family and family life\\",\\n \\"themeImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"topic\\": {\\n \\"topicName\\": \\"介绍家人\\",\\n \\"topicTranslate\\": \\"Introducing family members\\",\\n \\"topicImageList\\": [\\n \\"https://xxxxxxx/file_service/dialog/xxxxxx.png\\"\\n ]\\n },\\n \\"sentenceList\\": [\\n {\\n \\"sentenceId\\": \\"a774c6d09c4511eebe6e0c42a106bb02\\",\\n \\"sentenceText\\": \\"Is this your sister?\\",\\n \\"sentenceAnalysis\\": \\"Is + this + your + 家庭成员?\\"\\n }\\n ],\\n \\"wordList\\": [\\n {\\n \\"wordId\\": \\"a94c3337ed8c11eebe6e0c42a106bb02\\",\\n \\"wordText\\": \\"family\\",\\n \\"wordAnalysis\\": \\"家;家庭\\"\\n }\\n ],\\n \\"roleList\\": [\\n {\\n \\"roleName\\": \\"Carl\\",\\n \\"roleNameTranslate\\": \\"Carl\\",\\n \\"introduction\\": \\"Carl, a curious boy\\",\\n \\"introductionTranslate\\": \\"Carl,一个好奇的男孩\\",\\n \\"promoting\\": \\"Hi Noah, who is that in the photo?\\",\\n \\"promotingTranslate\\": \\"嗨 Noah,照片里的人是谁?\\",\\n \\"roleType\\": \\"0\\"\\n }\\n ],\\n \\"sceneTranslate\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '获取场景详情',
+ 'changeSet' => [
+ ['createdAt' => '2025-05-21T09:34:12.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantArticleDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'ModelRouterBillingCostTabs' => [
+ 'summary' => '获取用量监控Tab配置',
+ 'path' => '/api/v1/modelRouter/open/billing/cost/tabs',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
- 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
+ 'title' => 'OpenApiSingleResponse<List<CostTabDTO>>',
+ 'description' => 'OpenApiSingleResponse<List<CostTabDTO>>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'title' => '翻译结果',
- 'description' => '翻译结果',
- 'type' => 'string',
- 'example' => '太好了,谢谢你过来,莉莉。你喜欢吃肉吗?',
- ],
- ],
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据结构体', 'example' => '[]', '$ref' => '#/components/schemas/CostTabDTO'],
'example' => '[]',
],
+ 'maxResults' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": [{"key": "all", "label": "全部", "model_types": []}],'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": \\"太好了,谢谢你过来,莉莉。你喜欢吃肉吗?\\"\\n }\\n}","type":"json"}]',
- 'title' => '执行同步练翻译',
- ],
- 'GetAITeacherSyncDialogueSuggestion' => [
- 'summary' => '同步练小助手。',
- 'path' => '/api/v1/aiteacher/syncPractice/suggestion',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => '获取用量监控Tab配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"key\\": \\"all\\",\\n \\"label\\": \\"全部\\",\\n \\"modelTypes\\": [\\n \\"Chat\\"\\n ]\\n }\\n ],\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterChatCompletions' => [
+ 'path' => '/api/v1/modelRouter/open/chat/completions',
+ 'methods' => ['post'],
+ 'schemes' => ['https', 'sse'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/octet-stream'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '259937',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'schema' => ['title' => '聊天请求体', 'description' => '聊天请求体', 'type' => 'any', 'required' => false, 'example' => ' {'."\n"
+ .' "stream": true,'."\n"
+ .' "messages": ['."\n"
+ .' {'."\n"
+ .' "role": "user",'."\n"
+ .' "content": "1+1"'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "model_id": 15,'."\n"
+ .' "stream_options": {'."\n"
+ .' "include_usage": true'."\n"
+ .' }'."\n"
+ .' }'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse',
+ 'description' => 'OpenApiSingleResponse',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'type' => 'any', 'example' => '[]'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": "chatcmpl-xxx", "choices": [{"message": {"role": "assistant", "content": "你好!"}}]},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
],
],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '聊天对话',
+ 'summary' => '聊天/聊天接口',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterChatCompletions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": \\"[]\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterConfigureClientBalance' => [
+ 'summary' => '客户管理/启用部门余额限流',
+ 'path' => '/api/v1/modelRouter/open/clients/{id}/balance',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
'parameters' => [
[
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '部门ID', 'description' => '部门ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
'name' => 'body',
'in' => 'body',
'style' => 'json',
'schema' => [
+ 'title' => '请求body参数',
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录结构体',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用。'."\n"
- .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
- .'跑题超过两次,取值会强制置为true,用于强制切换任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
- ],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'languageCode' => [
- 'title' => '语言编码',
- 'description' => '语言编码',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-us' => '美式英语',
- 'en-gb' => '英式英语',
- ],
- 'example' => 'en-gb',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
- ],
+ 'enableBalance' => ['title' => '是否启用余额限流,余额一旦开启不可关闭', 'description' => '是否启用余额限流,余额一旦开启不可关闭', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ 'balanceType' => ['title' => '余额类型:amount(金额)/ tokens(token数量),首次启用时必填,一旦设置不可修改', 'description' => '余额类型:amount(金额)/ tokens(token数量),首次启用时必填,一旦设置不可修改', 'type' => 'string', 'required' => false, 'example' => 'amount'],
+ 'initialBalance' => ['title' => '初始余额,仅在首次启用时生效', 'description' => '初始余额,仅在首次启用时生效', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '100.00'],
],
'required' => false,
],
@@ -7011,93 +5729,141 @@
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
- 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
+ 'title' => 'OpenApiSingleResponse<ClientBalanceDTO>',
+ 'description' => 'OpenApiSingleResponse<ClientBalanceDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'data' => [
- 'title' => '数据对象',
- 'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'englishResult' => [
- 'title' => '小助手的英文提示',
- 'description' => '小助手的英文提示',
- 'type' => 'string',
- 'example' => 'Thanks, Lily. Do you like meat, Lily?',
- ],
- 'chineseResult' => [
- 'title' => '小助手的中文提示',
- 'description' => '小助手的中文提示',
- 'type' => 'string',
- 'example' => '谢谢莉莉.你喜欢吃肉吗,莉莉?',
- ],
- ],
- 'example' => '[]',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '{}', '$ref' => '#/components/schemas/ClientBalanceDTO'],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "client_id": 1, "balance": 100.00, "balance_type": "amount", "enable_balance": true},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"chineseResult\\": \\"谢谢莉莉.你喜欢吃肉吗,莉莉?\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取同步练小助手提示',
- ],
- 'AITeacherExpansionPracticeTaskGenerate' => [
- 'summary' => '拓展练问答对生成。',
- 'path' => '/api/v1/aiteacher/expansionPractice/generateTask',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'B.Validation.InvalidParameterException', 'errorMessage' => '请求参数无效', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => '客户管理/启用部门余额限流',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterCopyApiKey' => [
+ 'path' => '/api/v1/modelRouter/open/apikeys/{id}/copy',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'operationType' => 'readAndWrite',
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
'riskType' => 'none',
- 'chargeType' => 'paid',
- 'abilityTreeCode' => '258684',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '密钥ID', 'description' => '密钥ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ApiKeyDTO>',
+ 'description' => 'OpenApiSingleResponse<ApiKeyDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ApiKeyDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 2, "name": "复制的Key", "key": "sk-copy"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '复制api密钥',
+ 'summary' => 'API密鐥管理/复API密鐥',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCopyApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"deleteTag\\": 0,\\n \\"key\\": \\"key\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterCreateApiKey' => [
+ 'summary' => 'API密鐥管理/创建API密鐥',
+ 'path' => '/api/v1/modelRouter/open/apikeys',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
'parameters' => [
[
'name' => 'body',
@@ -7107,206 +5873,623 @@
'description' => '请求body参数。',
'type' => 'object',
'properties' => [
- 'userId' => [
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '6440xxxxxxxxxx5fafc98c421',
- ],
- 'grade' => [
- 'description' => '年级',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 3 => '小学3年级',
- '小学4年级',
- '小学5年级',
- '小学6年级',
- '中学7年级',
- '中学8年级',
- '中学9年级',
- '中学10年级',
- '中学11年级',
- '中学12年级',
- '大学',
- ],
- 'example' => '13',
- ],
- 'textbook' => [
- 'description' => '教材名称',
- 'type' => 'string',
- 'required' => false,
- 'example' => '英语(基础模块)修订版',
- ],
- 'topic' => [
- 'description' => '对话主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'talk about your dream job.',
- ],
- 'learningObject' => [
- 'description' => '学习目标',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Understanding unique professions such as dog walkers, hotel test sleepers, and food tasters, including their job responsibilities and the benefits or challenges associated with each role.',
- ],
- 'textContent' => [
- 'description' => '用于生成问题的参考文章',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [],
- 'example' => 'Dog walker Dog walking, as a profession, originated in the US. Some may think that it\'s a perfect job, because dog walkers won\'t be imprisoned in an office. But it\'s actually manual labour. At their busiest, dog walkers may have more than ten dogs to take care of in a day. Hotel test sleeper A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining and other services of hotels, in order to provide evaluations and guides for travelers. Hotel test sleepers don\'t need to punch in for work and they get about ten thousand yuan as income every month. What a comfortable job! Food taster In ancient times, a food taster was a person who tasted foods (or drinks) to be served to someone else, to confirm that it was safe to eat. But now, those working as food tasters just get to taste various new foods and drinks aimed at specific regions across the world. They then give their opinions on these products to the companies and suggest improvements.',
- ],
- 'keySentences' => [
- 'description' => '重点学习句子集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '重点学习句子',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'A hotel test sleeper, as the name suggests, has to write expert reviews about the facilities, locations, prices, dining, and other services of hotels.',
- ],
- 'required' => false,
- ],
- 'keyWords' => [
- 'description' => '重点学习单词集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '重点学习单词',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'responsibility',
- ],
- 'required' => false,
- ],
+ 'clientId' => ['title' => '客户ID,null表示默认客户', 'description' => '客户ID,null表示默认客户', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
'required' => false,
+ 'title' => '请求body参数。',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Schema of Response',
- 'description' => '响应结构体',
+ 'title' => 'OpenApiSingleResponse<ApiKeyDTO>',
+ 'description' => 'OpenApiSingleResponse<ApiKeyDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => 'Id of the request',
- 'description' => '请求Id',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ApiKeyDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "新Key", "key": "sk-newkey"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '创建api密钥',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"deleteTag\\": 0,\\n \\"key\\": \\"key\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterCreateBalanceTransaction' => [
+ 'path' => '/api/v1/modelRouter/open/clients/{id}/balance/transactions',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '部门ID', 'description' => '部门ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '请求body参数',
+ 'description' => '请求body参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'type' => ['title' => '交易类型', 'description' => '交易类型', 'type' => 'string', 'required' => false, 'example' => 'recharge'],
+ 'amount' => ['title' => '交易金额', 'description' => '交易金额', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '100.00'],
+ 'remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'required' => false, 'example' => '充值'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ClientBalanceDTO>',
+ 'description' => 'OpenApiSingleResponse<ClientBalanceDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '{}', '$ref' => '#/components/schemas/ClientBalanceDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "client_id": 1, "balance": 200.00, "balance_type": "amount", "enable_balance": true},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '客户管理/创建余额交易',
+ 'summary' => '客户管理/创建余额交易',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterCreateBillingRule' => [
+ 'path' => '/api/v1/modelRouter/open/billing/rules',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '计费规则创建请求',
+ 'description' => '计费规则创建请求',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ 'billingType' => ['title' => '计费类型:token_tiered/per_image/per_duration/per_character/video_matrix/token_flat/omni_multimodal', 'description' => '计费类型:configurable', 'type' => 'string', 'required' => false, 'example' => 'configurable'],
+ 'pricingConfig' => ['title' => '计费配置JSON', 'description' => 'pricingConfig 为 JSON 对象,其内部字段结构根据计费类型不同而变化。'."\n"
+ .'1. Token 阶梯计费'."\n"
+ .'适用于 Chat 类模型。按输入 Token 数量分阶梯计价,支持常规模式、思考模式、缓存命中三种价格维度。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "tiers": ['."\n"
+ .' {'."\n"
+ .' "min_tokens": 0,'."\n"
+ .' "max_tokens": 32000,'."\n"
+ .' "input_price": 2.5,'."\n"
+ .' "output_price": 10,'."\n"
+ .' "thinking_input_price": 2.5,'."\n"
+ .' "thinking_output_price": 10,'."\n"
+ .' "cached_input_price": 2.5'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "min_tokens": 32000,'."\n"
+ .' "max_tokens": 128000,'."\n"
+ .' "input_price": 4,'."\n"
+ .' "output_price": 16,'."\n"
+ .' "thinking_input_price": 4,'."\n"
+ .' "thinking_output_price": 16,'."\n"
+ .' "cached_input_price": 4'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'tiers array 是 阶梯定价数组,至少一个元素 -'."\n"
+ .'tiers[].min_tokens integer 是 当前阶梯 Token 数量下限(含) Token'."\n"
+ .'tiers[].max_tokens integer 是 当前阶梯 Token 数量上限(不含),0 表示不限 Token'."\n"
+ .'tiers[].input_price number 是 常规模式输入 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].output_price number 是 常规模式输出 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].thinking_input_price number 否 思考模式输入 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].thinking_output_price number 否 思考模式输出 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].cached_input_price number 否 缓存命中时输入 Token 单价 元 / 百万 Token'."\n"
+ .'约束:'."\n"
+ .'第一个阶梯的 min_tokens 必须为 0'."\n"
+ .'非最后一个阶梯的 max_tokens 必须大于 min_tokens'."\n"
+ .'相邻阶梯必须连续衔接(前一阶梯 max_tokens = 后一阶梯 min_tokens),不允许重叠或间隙'."\n"
+ ."\n"
+ .'2. 按图片计费'."\n"
+ .'适用于 ImageGeneration、ImageEdit 类模型。按生成/处理图片的张数计价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "price_per_image": 0.2'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'price_per_image number 是 每张图片的计费单价 元 / 张'."\n"
+ ."\n"
+ .'3. 视频矩阵计费'."\n"
+ .'适用于 VideoGeneration、VideoImageGeneration 类模型。按视频分辨率和是否有音频两个维度组合定价。'."\n"
+ .'注意: 前端交互时使用 matrix 字段,但调用 API 保存时需使用 tiers 字段(matrix 会在服务端自动转换)。以下给出的是 API 侧的标准格式。'."\n"
+ .'JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "tiers": ['."\n"
+ .' {'."\n"
+ .' "resolution": 480,'."\n"
+ .' "has_audio": 0,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "resolution": 480,'."\n"
+ .' "has_audio": 1,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "resolution": 720,'."\n"
+ .' "has_audio": 0,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "resolution": 720,'."\n"
+ .' "has_audio": 1,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "default_price_per_second": 0.24'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'tiers array 是 视频矩阵定价数组 -'."\n"
+ .'tiers[].resolution integer 是 视频分辨率,取值:480、720、1080 像素高度(p)'."\n"
+ .'tiers[].has_audio integer 是 是否包含音频,取值:0(无声)、1(有声) -'."\n"
+ .'tiers[].price_per_second number 是 该组合下的每秒单价 元 / 秒'."\n"
+ .'default_price_per_second number 否 未匹配到矩阵项时的默认每秒单价 元 / 秒'."\n"
+ .'约束:'."\n"
+ .'resolution 仅支持 480p、720p、1080p'."\n"
+ .'resolution + has_audio 组合不可重复'."\n"
+ ."\n"
+ .'4. 按时长计费'."\n"
+ .'适用于 ASR(语音识别)类模型。按音频时长计价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "price_per_unit": 0.00022'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'price_per_unit number 是 音频每秒计费单价 元 / 秒'."\n"
+ ."\n"
+ .'5. 按字符计费'."\n"
+ .'适用于 TTS(语音合成)类模型。按合成文本的字符数计价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "price_per_unit": 0.8'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'price_per_unit number 是 每万字符计费单价 元 / 万字符'."\n"
+ ."\n"
+ .'6. Token 统一计费'."\n"
+ .'适用于 Embedding、Rerank、MultimodalEmbedding、MultimodalRerank 类模型。不区分阶梯,按统一单价计费。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "input_price": 0.5,'."\n"
+ .' "multimodal_input_price": 0.5'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'input_price number 是 纯文本输入 Token 单价 元 / 百万 Token'."\n"
+ .'multimodal_input_price number 否 多模态输入 Token 单价 元 / 百万 Token'."\n"
+ ."\n"
+ .'7. 全模态多维度计费'."\n"
+ .'适用于 ChatFullmodal 类全模态模型(如 qwen3.5-omni-plus)。对文本、音频、图片、视频等不同模态的输入和输出分别定价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "text_input_price": 7,'."\n"
+ .' "audio_input_price": 53,'."\n"
+ .' "image_input_price": 7,'."\n"
+ .' "video_input_price": 7,'."\n"
+ .' "text_output_price": 40,'."\n"
+ .' "audio_output_price": 213,'."\n"
+ .' "multi_text_output_price": 0'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'text_input_price number 是 文本输入 Token 单价 元 / 百万 Token'."\n"
+ .'audio_input_price number 是 音频输入 Token 单价 元 / 百万 Token'."\n"
+ .'image_input_price number 否 图片输入 Token 单价 元 / 百万 Token'."\n"
+ .'video_input_price number 否 视频输入 Token 单价 元 / 百万 Token'."\n"
+ .'text_output_price number 是 文本输出 Token 单价 元 / 百万 Token'."\n"
+ .'audio_output_price number 否 音频输出 Token 单价 元 / 百万 Token'."\n"
+ .'multi_text_output_price number 否 多模态输入后的文本输出 Token 单价(当输入包含图片/音频/视频时,文本输出的单独计价) 元 / 百万 Token', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' "tiers":['."\n"
+ .' {'."\n"
+ .' "input_price":2.5,'."\n"
+ .' "cached_input_price":2.5,'."\n"
+ .' "max_tokens":32000,'."\n"
+ .' "output_price":10,'."\n"
+ .' "thinking_output_price":10,'."\n"
+ .' "thinking_input_price":2.5,'."\n"
+ .' "min_tokens":0'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "input_price":4,'."\n"
+ .' "cached_input_price":4,'."\n"
+ .' "max_tokens":128000,'."\n"
+ .' "output_price":16,'."\n"
+ .' "thinking_output_price":16,'."\n"
+ .' "thinking_input_price":4,'."\n"
+ .' "min_tokens":32000'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "input_price":7,'."\n"
+ .' "cached_input_price":7,'."\n"
+ .' "max_tokens":252000,'."\n"
+ .' "output_price":28,'."\n"
+ .' "thinking_output_price":28,'."\n"
+ .' "thinking_input_price":7,'."\n"
+ .' "min_tokens":128000'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' }'],
+ 'effectiveTime' => ['title' => '生效时间,RFC3339格式', 'description' => '生效时间,RFC3339格式', 'type' => 'string', 'required' => false, 'example' => '2024-01-01T00:00:00Z'],
+ 'expireTime' => ['title' => '过期时间,RFC3339格式', 'description' => '过期时间,RFC3339格式', 'type' => 'string', 'required' => false, 'example' => '2025-01-01T00:00:00Z'],
+ 'version' => ['title' => '计费规则版本号', 'description' => '计费规则版本号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<BillingRuleResp>',
+ 'description' => 'OpenApiSingleResponse<BillingRuleResp>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'description' => '数据对象',
+ 'title' => '返回数据',
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'taskType' => [
- 'description' => '任务类型',
- 'type' => 'string',
- 'example' => 'textbook_dialogue',
- ],
- 'taskContent' => [
- 'description' => '问答对集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '问答对',
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'description' => 'AI老师提问',
- 'type' => 'string',
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'user' => [
- 'description' => '学生回答',
- 'type' => 'string',
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- ],
- ],
- ],
- 'backgroundDescription' => [
- 'description' => '对话背景描述',
- 'type' => 'string',
- 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.',
- ],
- 'startSentence' => [
- 'description' => '起始句子',
- 'type' => 'string',
- 'example' => 'Hey Jamie, do you know what a travel blogger does?',
- ],
- 'roleSet' => [
- 'description' => '角色设置',
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'description' => 'AI老师扮演者',
- 'type' => 'string',
- 'example' => 'Alex',
- ],
- 'user' => [
- 'description' => '学生扮演者',
- 'type' => 'string',
- 'example' => 'Jamie',
- ],
- ],
- ],
+ 'id' => ['title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelCode' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'example' => 'qwen-plus'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问Plus'],
+ 'modelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'example' => 'chat'],
+ 'symbol' => ['title' => '厂商标识', 'description' => '厂商标识', 'type' => 'string', 'example' => 'alibaba'],
+ 'billingType' => ['title' => '计费类型', 'description' => '计费类型', 'type' => 'string', 'example' => 'token_tiered'],
+ 'pricingConfig' => ['title' => '计费配置', 'description' => '计费配置', 'type' => 'any', 'example' => '{}'],
+ 'effectiveTime' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'expireTime' => ['title' => '过期时间', 'description' => '过期时间', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'],
+ 'version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'deleteTag' => ['title' => '删除标记', 'description' => '删除标记', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
],
],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "model_id": 1, "billing_type": "token_tiered"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'staticInfo' => [
- 'returnType' => 'synchronous',
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => '鉴权失败-组织不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"taskType\\": \\"textbook_dialogue\\",\\n \\"taskContent\\": [\\n {\\n \\"assistant\\": \\"Why might some people think dog walking is a great job?\\",\\n \\"user\\": \\"They think it\'s great because they won\'t be stuck in an office.\\"\\n }\\n ],\\n \\"backgroundDescription\\": \\"In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.\\",\\n \\"startSentence\\": \\"Hey Jamie, do you know what a travel blogger does?\\",\\n \\"roleSet\\": {\\n \\"assistant\\": \\"Alex\\",\\n \\"user\\": \\"Jamie\\"\\n }\\n }\\n}","type":"json"}]',
- 'title' => '拓展练对话任务生成',
+ 'title' => '计费管理/创建计费规则',
+ 'summary' => '计费管理/创建计费规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问Plus\\",\\n \\"modelType\\": \\"chat\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"billingType\\": \\"token_tiered\\",\\n \\"pricingConfig\\": \\"{}\\",\\n \\"effectiveTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"expireTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"version\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
],
- 'ExecuteAITeacherExpansionDialogue' => [
- 'summary' => '拓展练习对话主要针对较为开放的交流场景。在练习过程中,虽然AI提出的问题没有预设答案,但用户仍需在相关话题内进行回答。若用户回答偏离主题,AI会尝试引导其回归话题。如果用户连续两次跑题,AI将引导其继续下一个话题。',
- 'path' => '/api/v1/aiteacher/expansionPractice/executeExpansionTraining',
- 'methods' => [
- 'post',
+ 'ModelRouterCreateClient' => [
+ 'summary' => '客户管理/创建客户',
+ 'path' => '/api/v1/modelRouter/open/clients',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '客户名称', 'description' => '客户名称', 'type' => 'string', 'required' => false, 'example' => '我的客户'],
+ 'address' => ['title' => '公司地址', 'description' => '公司地址', 'type' => 'string', 'required' => false, 'example' => '杭州市'],
+ 'contact' => ['title' => '联系方式', 'description' => '联系方式', 'type' => 'string', 'required' => false, 'example' => '13800138000'],
+ 'remark' => ['title' => '备注信息', 'description' => '备注信息', 'type' => 'string', 'required' => false, 'example' => '备注'],
+ 'allowedModels' => ['title' => '允许的模型ID列表,逗号分隔,空表示全部', 'description' => '允许的模型ID列表,逗号分隔,空表示全部', 'type' => 'string', 'required' => false, 'example' => '1,2,3'],
+ 'discount' => ['title' => '折扣系数,1.0=无折扣,0.8=八折,不传默认1.0', 'type' => 'number', 'format' => 'double', 'example' => '1.0'],
+ 'parentId' => ['title' => '父部门ID,不传则创建顶层部门', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ 'required' => false,
+ 'title' => '请求body参数',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ClientDTO>',
+ 'description' => 'OpenApiSingleResponse<ClientDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ClientDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "新客户"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => '创建客户',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateClient',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterCreateConversation' => [
+ 'summary' => '对话管理/创建对话',
+ 'path' => '/api/v1/modelRouter/open/conversations',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
'operationType' => 'create',
- 'abilityTreeCode' => '259932',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ 'tenantRelevance' => 'tenant',
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'chatData' => ['title' => '对话数据JSON,包含各模型的消息记录(必填)', 'description' => '对话数据JSON,包含各模型的消息记录(必填)', 'type' => 'string', 'required' => false, 'example' => '{"stream":true,"messages":[{"role":"user","content":"1+1"}],"model":"qwen/qwen-max/r0","stream_options":{"include_usage":true}}'],
+ 'modelIds' => ['title' => '模型ID列表,JSON数组字符串', 'description' => '模型ID列表,JSON数组字符串', 'type' => 'string', 'required' => false, 'example' => '15'],
+ 'title' => ['title' => '对话标题,不传则自动从第一条用户消息提取', 'description' => '对话标题,不传则自动从第一条用户消息提取', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ 'required' => false,
+ 'title' => '请求body参数。',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ConversationDTO>',
+ 'description' => 'OpenApiSingleResponse<ConversationDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ConversationDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "title": "新对话"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建会话',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'tenantRelevance' => 'publicInformation',
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterCreateModel' => [
+ 'summary' => '模型管理/创建模型。',
+ 'path' => '/api/v1/modelRouter/open/models',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ 'tenantRelevance' => 'tenant',
],
'parameters' => [
[
@@ -7314,1432 +6497,3870 @@
'in' => 'body',
'style' => 'json',
'schema' => [
+ 'title' => '请求结构体',
'description' => '请求body参数',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录结构体',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'assistant' => '老师',
- 'user' => '学生',
- ],
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用。'."\n"
- .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
- .'跑题超过两次,取值会强制置为true,用于强制切换任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => false,
- ],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
- ],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => true,
- ],
- 'required' => true,
- ],
- 'languageCode' => [
- 'title' => '语言编码',
- 'description' => '语言编码',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-us' => '美式英语',
- 'en-gb' => '英式英语',
- ],
- 'example' => 'en-gb',
- ],
- 'background' => [
- 'title' => '对话背景描述',
- 'description' => '对话背景描述',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.',
- ],
- 'roleInfo' => [
- 'title' => '角色设置',
- 'description' => '角色设置',
+ 'name' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'required' => false, 'example' => '通义千问'],
+ 'description' => ['title' => '模型描述', 'description' => '模型描述', 'type' => 'string', 'required' => false, 'example' => '通义千问大模型'],
+ 'symbol' => ['title' => '厂商symbol', 'description' => '厂商symbol', 'type' => 'string', 'required' => false, 'example' => 'alibaba'],
+ 'tags' => ['title' => '标签,逗号分隔', 'description' => '标签,逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'TXT_GEN,DEEP_THINK'],
+ 'modelId' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'required' => false, 'example' => 'qwen-turbo'],
+ 'modelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'required' => false, 'example' => 'Chat'],
+ 'apiKey' => ['title' => 'API Key', 'description' => 'API Key', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxx'],
+ 'baseUrl' => ['title' => 'Base URL', 'description' => 'Base URL', 'type' => 'string', 'required' => false, 'example' => 'https://dashscope.aliyuncs.com'],
+ 'maxInputLength' => ['title' => '最大输入长度', 'description' => '最大输入长度', 'type' => 'string', 'required' => false, 'example' => '32K'],
+ 'maxOutputLength' => ['title' => '最大输出长度', 'description' => '最大输出长度', 'type' => 'string', 'required' => false, 'example' => '8K'],
+ 'inOut' => ['title' => '描述模型支持的输入和输出数据类型', 'type' => 'string', 'required' => false, 'example' => 'text', 'description' => '描述模型支持的输入和输出数据类型'],
+ 'extensions' => ['title' => '模型的扩展配置参数,以 JSON 字符串存储', 'type' => 'string', 'required' => false, 'example' => '{}', 'description' => '模型的扩展配置参数,以 JSON 字符串存储'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ModelDTO>',
+ 'description' => 'OpenApiSingleResponse<ModelDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "gpt-4", "type": "chat"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'staticInfo' => ['returnType' => 'synchronous'],
+ 'title' => '创建模型',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterDeleteApiKey' => [
+ 'summary' => 'API密鐥管理/删除API密鐥',
+ 'path' => '/api/v1/modelRouter/open/apikeys/{id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '密钥ID', 'description' => '密钥ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<Boolean>',
+ 'description' => 'OpenApiSingleResponse<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": true,'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '删除api密钥',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]',
+ ],
+ 'ModelRouterDeleteClient' => [
+ 'summary' => '客户管理/删除客户',
+ 'path' => '/api/v1/modelRouter/open/clients/{id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '客户ID', 'description' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<Boolean>',
+ 'description' => 'OpenApiSingleResponse<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": true,'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '删除客户',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteClient',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]',
+ ],
+ 'ModelRouterDeleteConversation' => [
+ 'summary' => '对话管理/删除对话',
+ 'path' => '/api/v1/modelRouter/open/conversations/{id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '对话ID', 'description' => '对话ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<Boolean>',
+ 'description' => 'OpenApiSingleResponse<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": true,'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '删除会话',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]',
+ ],
+ 'ModelRouterDeleteModel' => [
+ 'path' => '/api/v1/modelRouter/open/models/{id}',
+ 'methods' => ['delete'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'delete',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<Boolean>',
+ 'description' => 'OpenApiSingleResponse<Boolean>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '是否删除成功', 'type' => 'boolean', 'example' => 'true'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": true,'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '删除模型',
+ 'summary' => '模型管理/删除模型',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]',
+ ],
+ 'ModelRouterGetClientBalance' => [
+ 'summary' => '客户管理/获取部门余额',
+ 'path' => '/api/v1/modelRouter/open/clients/{id}/balance',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '部门ID', 'description' => '部门ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ClientBalanceDTO>',
+ 'description' => 'OpenApiSingleResponse<ClientBalanceDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '{}', '$ref' => '#/components/schemas/ClientBalanceDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "client_id": 1, "balance": 100.00, "balance_type": "amount", "enable_balance": true},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '客户管理/获取部门余额',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterGetClientBalanceLogs' => [
+ 'summary' => '客户管理/获取部门余额变更日志',
+ 'path' => '/api/v1/modelRouter/open/clients/{id}/balance/logs',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '部门ID', 'description' => '部门ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'changeType',
+ 'in' => 'query',
+ 'schema' => ['title' => '变更类型过滤: auto_deduct/deduct/recharge', 'description' => '变更类型过滤: auto_deduct/deduct/recharge', 'type' => 'string', 'required' => false, 'example' => 'recharge'],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'size',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页条数', 'description' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'default' => '20'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '下一次请求的分页游标值。', 'type' => 'string', 'required' => false, 'example' => 'None'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiPageResponse<ClientBalanceLogDTO>',
+ 'description' => 'OpenApiPageResponse<ClientBalanceLogDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '返回数据',
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'title' => '老师扮演者',
- 'description' => 'AI的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Alex',
- ],
- 'user' => [
- 'title' => '学生扮演者',
- 'description' => '用户的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Jamie',
+ 'total' => ['description' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'page' => ['description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'list' => [
+ 'title' => '余额变更日志列表',
+ 'description' => '余额变更日志列表',
+ 'type' => 'array',
+ 'items' => ['description' => '余额变更日志项', '$ref' => '#/components/schemas/ClientBalanceLogDTO'],
],
],
- 'required' => true,
- ],
- 'topic' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Let\'s talk about traffic rules.',
- ],
- 'startSentence' => [
- 'title' => '开场语',
- 'description' => '开场语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Hello Lily, could you please come to the kitchen for a moment?',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
],
+ 'maxResults' => ['description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'None'],
],
- 'required' => false,
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 20,'."\n"
+ .' "list": [{"id": 1, "client_id": 1, "change_amount": 100.00, "change_type": "recharge"}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '客户管理/获取部门余额变更日志',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 100,\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"changeAmount\\": 10,\\n \\"balanceBefore\\": 90,\\n \\"balanceAfter\\": 100,\\n \\"changeType\\": \\"recharge\\",\\n \\"remark\\": \\"充值\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"None\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryApiKey' => [
+ 'summary' => 'API密鐥管理/获取API密鐥详情',
+ 'path' => '/api/v1/modelRouter/open/apikeys/{id}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'get',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '密钥ID', 'description' => '密钥ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AITeacherExpansionTrainDTO>',
- 'description' => 'OpenApiSingleResponse<AITeacherExpansionTrainDTO>',
+ 'title' => 'OpenApiSingleResponse<ApiKeyDecryptedDTO>',
+ 'description' => 'OpenApiSingleResponse<ApiKeyDecryptedDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ApiKeyDecryptedDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "测试Key", "key": "sk-xxx", "decryptedKey": "sk-full-key"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取api密钥信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"key\\": \\"sk-xxxxxxxxxxxxxxxxxxx\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryApiKeyList' => [
+ 'summary' => 'API密钥管理/获取API密钥列表。',
+ 'path' => '/api/v1/modelRouter/open/apikeys',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户ID筛选', 'description' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'status',
+ 'in' => 'query',
+ 'schema' => ['title' => '状态筛选', 'description' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页token,为空表示没有下一页', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => 'nextToken'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiPageResponse<ApiKeyDTO>',
+ 'description' => 'OpenApiPageResponse<ApiKeyDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '数据对象',
+ 'title' => '返回数据对象',
'description' => '数据对象',
'type' => 'object',
+ 'items' => ['description' => '返回数据对象', 'extendType' => 'true', '$ref' => '#/components/schemas/ApiKeyDTO'],
+ 'example' => '[]',
'properties' => [
- 'englishResult' => [
- 'title' => 'AI老师的英文回复',
- 'description' => 'AI老师的英文回复',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'chineseResult' => [
- 'title' => 'AI老师的中文回复',
- 'description' => 'AI老师的中文回复',
- 'type' => 'string',
- 'example' => '1',
- ],
- 'isFinish' => [
- 'title' => '是否完成对话',
- 'description' => '是否完成对话',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题',
- 'description' => '是否跑题',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'questionIndex' => [
- 'title' => '当前作答的问题编号',
- 'description' => '当前作答的问题编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '2',
- ],
+ 'total' => ['title' => '总记录数。', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'maxResult' => ['title' => '分页大小,默认为20', 'type' => 'string'],
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'list' => [
+ 'title' => '元素',
+ 'type' => 'array',
+ 'items' => ['title' => '分页数据。', 'example' => '{'."\n"
+ .' "gmt_create":"2026-03-19T10:44:16.139455+08:00",'."\n"
+ .' "delete_tag":0,'."\n"
+ .' "name":"阿斯旺答授权",'."\n"
+ .' "client":{'."\n"
+ .' "gmt_create":"2026-03-19T10:44:06.176949+08:00",'."\n"
+ .' "address":"1222222222222",'."\n"
+ .' "delete_tag":0,'."\n"
+ .' "contact":"11111111",'."\n"
+ .' "name":"阿斯旺答",'."\n"
+ .' "client_uuid":"st_ehe8K1F05A2QK",'."\n"
+ .' "remark":"222222222",'."\n"
+ .' "main":1,'."\n"
+ .' "id":51,'."\n"
+ .' "gmt_modified":"2026-03-19T10:44:06.17695+08:00",'."\n"
+ .' "allowed_models":"79"'."\n"
+ .' },'."\n"
+ .' "key_preview":"sk-4a8c****cb20",'."\n"
+ .' "id":104,'."\n"
+ .' "gmt_modified":"2026-03-19T10:44:16.139456+08:00",'."\n"
+ .' "client_id":51,'."\n"
+ .' "key":""'."\n"
+ .' }', '$ref' => '#/components/schemas/ApiKeyDTO'],
+ ],
+ 'nextToken' => ['title' => 'nextToken', 'type' => 'string', 'example' => 'None'],
+ 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
- 'example' => '[]',
],
+ 'maxResults' => ['title' => 'maxResults', 'description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": [{"id": 1, "name": "测试Key", "key": "sk-xxx"}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"1\\",\\n \\"chineseResult\\": \\"1\\",\\n \\"isFinish\\": true,\\n \\"isOffTopicControl\\": true,\\n \\"isOnTopic\\": true,\\n \\"questionIndex\\": 2\\n }\\n}","type":"json"}]',
- 'title' => '执行拓展练',
- ],
- 'ExecuteAITeacherExpansionDialogueTranslate' => [
- 'summary' => '拓展练语境翻译。',
- 'path' => '/api/v1/aiteacher/expansionPractice/translate',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => '获取api密钥列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryApiKeyList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 0,\\n \\"maxResult\\": \\"\\",\\n \\"page\\": 1,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"deleteTag\\": 0,\\n \\"key\\": \\"key\\"\\n }\\n ],\\n \\"nextToken\\": \\"None\\",\\n \\"pageSize\\": 10\\n },\\n \\"maxResults\\": 10\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryBillingCostBreakdown' => [
+ 'path' => '/api/v1/modelRouter/open/billing/cost/breakdown',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
- 'abilityTreeCode' => '259941',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询开始时间,Unix时间戳(秒)', 'description' => '查询开始时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询结束时间,Unix时间戳(秒)', 'description' => '查询结束时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'],
+ ],
+ [
+ 'name' => 'granularity',
+ 'in' => 'query',
+ 'schema' => ['title' => '聚合粒度:hourly 或 daily', 'description' => '聚合粒度:hourly 或 daily', 'type' => 'string', 'required' => true, 'example' => 'hourly'],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码,默认1', 'description' => '页码,默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页条数,默认20,最大500', 'description' => '每页条数,默认20,最大500', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '12'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '5'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ ],
+ [
+ 'name' => 'modelTypes',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'Chat'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大返回数量', 'description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => '翻页标识', 'description' => '翻页标识', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<BillingCostBreakdownRespDTO>',
+ 'description' => 'OpenApiSingleResponse<BillingCostBreakdownRespDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '{}', '$ref' => '#/components/schemas/BillingCostBreakdownRespDTO'],
+ 'maxResults' => ['title' => '最大返回数量', 'description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'nextToken' => ['title' => '翻页标识', 'description' => '翻页标识', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"granularity": "hourly", "total": 100, "page": 1, "page_size": 20, "rows": []},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
+ 'title' => '计费批量明细查询',
+ 'summary' => '计费管理/批量查询计费明细',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryBillingCostBreakdown',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"granularity\\": \\"hourly\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"total\\": 100,\\n \\"columns\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"rows\\": [\\n {\\n \\"summaryTime\\": 1700000000,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"modelType\\": \\"llm\\",\\n \\"clientId\\": 0,\\n \\"clientName\\": \\"研发部\\",\\n \\"apiKeyId\\": 0,\\n \\"apiKeyName\\": \\"默认密钥\\",\\n \\"billingType\\": \\"total_amount\\",\\n \\"payableAmount\\": 0.000128,\\n \\"dimValues\\": \\"{\\\\\\"billing_version\\\\\\": \\\\\\"v1\\\\\\"}\\",\\n \\"values\\": \\"{\\\\\\"input_tokens\\\\\\": 512000, \\\\\\"output_tokens\\\\\\": 256000}\\",\\n \\"tiers\\": [\\n {\\n \\"dimValues\\": \\"{\\\\\\"context_tier\\\\\\": \\\\\\"0-32k\\\\\\"}\\",\\n \\"values\\": \\"{\\\\\\"input_tokens\\\\\\": 1000, \\\\\\"output_tokens\\\\\\": 500}\\",\\n \\"payableAmount\\": 0.05\\n }\\n ]\\n }\\n ]\\n },\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryBillingRuleList' => [
+ 'path' => '/api/v1/modelRouter/open/billing/rules',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码,默认1', 'description' => '页码,默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量,默认20', 'description' => '每页数量,默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码(优先使用)', 'description' => '页码(优先使用)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型类型过滤', 'description' => '模型类型过滤', 'type' => 'string', 'required' => false, 'example' => 'chat'],
+ ],
+ [
+ 'name' => 'modelCode',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型标识过滤', 'description' => '模型标识过滤', 'type' => 'string', 'required' => false, 'example' => 'qwen-plus'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型ID过滤', 'description' => '模型ID过滤(必填)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'activeOnly',
+ 'in' => 'query',
+ 'schema' => ['title' => '仅返回当前生效的规则', 'description' => '仅返回当前生效的规则', 'type' => 'boolean', 'required' => false, 'example' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求body参数',
+ 'title' => 'OpenApiPageResponse<BillingRuleResp>',
+ 'description' => 'OpenApiPageResponse<BillingRuleResp>',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录集合',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用。'."\n"
- .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
- .'跑题超过两次,取值会强制置为true,用于强制切换任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '返回数据',
+ 'description' => '返回数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'total' => ['title' => '总记录数', 'description' => '总记录数', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'page' => ['title' => '当前页码', 'description' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'list' => [
+ 'title' => '计费规则列表',
+ 'description' => '计费规则列表',
+ 'type' => 'array',
+ 'items' => [
+ 'title' => '计费规则',
+ 'description' => '计费规则',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelCode' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'example' => 'qwen-plus'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问Plus'],
+ 'modelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'example' => 'chat'],
+ 'symbol' => ['title' => '厂商标识', 'description' => '厂商标识', 'type' => 'string', 'example' => 'alibaba'],
+ 'billingType' => ['title' => '计费类型', 'description' => '计费类型', 'type' => 'string', 'example' => 'token_tiered'],
+ 'pricingConfig' => ['title' => '计费配置', 'description' => '计费配置', 'type' => 'any', 'example' => '{}'],
+ 'effectiveTime' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'expireTime' => ['title' => '过期时间', 'description' => '过期时间', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'],
+ 'version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'deleteTag' => ['title' => '删除标记', 'description' => '删除标记', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ ],
],
],
- 'required' => false,
],
- 'required' => false,
],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
+ 'maxResults' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "page_size": 20,'."\n"
+ .' "list": []'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => '鉴权失败-组织不存在'],
+ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '计费管理/查询计费规则列表',
+ 'summary' => '计费管理/查询计费规则列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 5,\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问Plus\\",\\n \\"modelType\\": \\"chat\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"billingType\\": \\"token_tiered\\",\\n \\"pricingConfig\\": \\"{}\\",\\n \\"effectiveTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"expireTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"version\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryClientDiscountLogs' => [
+ 'path' => '/api/v1/modelRouter/open/clients/{id}/discount-logs',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '客户ID', 'description' => '客户ID(必填)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResponse<List<ClientDiscountLog>>',
+ 'description' => 'OpenApiResponse<List<ClientDiscountLog>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '折扣修改历史列表',
+ 'description' => '折扣修改历史列表',
'type' => 'array',
'items' => [
+ 'description' => '返回结果。',
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
- ],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'background' => [
- 'title' => '对话背景描述',
- 'description' => '对话背景描述',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'In this dialogue, you will be playing the role of Lily, a young girl. I will be Jane, Lily\'s mother. We are in the kitchen, where I am preparing dinner. I am asking you about your food preferences, specifically if you like meat, fish, and milk. You like meat and milk, but you don\'t like fish because of its smell. I explain to you the nutritional benefits of these foods and suggest alternatives for the ones you don\'t like. Finally, I invite you to start eating.',
- ],
- 'roleInfo' => [
- 'title' => '角色设置',
- 'description' => '角色设置',
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'title' => '教师扮演角色',
- 'description' => 'AI的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Jane, a caring mother',
- ],
- 'user' => [
- 'title' => '学生扮演者',
- 'description' => '用户的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Lily, a friendly student',
+ 'id' => ['title' => '记录ID', 'description' => '记录ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'clientId' => ['title' => '客户ID', 'description' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'discount' => ['title' => '折扣', 'description' => '折扣', 'type' => 'number', 'format' => 'float', 'example' => '0.5'],
+ 'effectiveTime' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2025-09-01 00:00:00'],
+ 'expireTime' => ['title' => '过期时间', 'description' => '过期时间', 'type' => 'string', 'example' => '2025-09-10 00:00:00'],
+ 'remark' => ['title' => '备注', 'description' => '备注', 'type' => 'string', 'example' => '备注'],
+ 'deleteTag' => ['title' => '删除标记', 'description' => '删除标记', 'type' => 'integer', 'format' => 'int64', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
],
],
- 'required' => true,
- ],
- 'topic' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'talk about food.',
- ],
- 'startSentence' => [
- 'title' => '开场语',
- 'description' => '开场语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Hello Lily, could you please come to the kitchen for a moment?',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ 'maxResults' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
- 'required' => false,
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": [{"id": 1, "client_id": 1, "old_discount": 1.0, "new_discount": 0.8, "remark": "调整折扣"}],'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => '鉴权失败-组织不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '客户管理/获取部门折扣修改历史',
+ 'summary' => '客户管理/获取部门折扣修改历史',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"discount\\": 0.5,\\n \\"effectiveTime\\": \\"2025-09-01 00:00:00\\",\\n \\"expireTime\\": \\"2025-09-10 00:00:00\\",\\n \\"remark\\": \\"备注\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ],\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"maxResults\\": 10\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryClientList' => [
+ 'path' => '/api/v1/modelRouter/open/clients',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'status',
+ 'in' => 'query',
+ 'schema' => ['title' => '状态筛选', 'description' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页token,为空表示没有下一页', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
- 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiTranslateDTO>',
+ 'title' => 'OpenApiPageResponse<ClientDTO>',
+ 'description' => 'OpenApiPageResponse<ClientDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
+ 'items' => ['description' => '返回数据。', 'extendType' => 'true', '$ref' => '#/components/schemas/ClientDTO'],
+ 'example' => '[]',
'properties' => [
- 'result' => [
- 'title' => '翻译结果',
- 'description' => '翻译结果',
- 'type' => 'string',
- 'example' => '太好了,谢谢你过来,莉莉。你喜欢吃肉吗?',
+ 'total' => ['type' => 'integer', 'format' => 'int32'],
+ 'maxResults' => ['type' => 'string', 'example' => '1'],
+ 'page' => ['type' => 'integer', 'format' => 'int32'],
+ 'nextToken' => ['type' => 'string', 'example' => '1'],
+ 'pageSize' => ['type' => 'integer', 'format' => 'int32'],
+ 'list' => [
+ 'type' => 'array',
+ 'items' => ['example' => '{'."\n"
+ .' "gmt_create":"2026-03-19T10:44:06.176949+08:00",'."\n"
+ .' "address":"1222222222222",'."\n"
+ .' "delete_tag":0,'."\n"
+ .' "contact":"11111111",'."\n"
+ .' "name":"阿斯旺答",'."\n"
+ .' "client_uuid":"st_ehe8K1F05A2QK",'."\n"
+ .' "remark":"222222222",'."\n"
+ .' "main":1,'."\n"
+ .' "id":51,'."\n"
+ .' "gmt_modified":"2026-03-19T10:44:06.17695+08:00",'."\n"
+ .' "allowed_models":"79"'."\n"
+ .' }', '$ref' => '#/components/schemas/ClientDTO'],
],
],
- 'example' => '[]',
],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": [{"id": 1, "name": "测试客户"}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": \\"太好了,谢谢你过来,莉莉。你喜欢吃肉吗?\\"\\n }\\n}","type":"json"}]',
- 'title' => '执行拓展练翻译',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取客户信息',
+ 'summary' => '客户管理/获取客户列表。',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryClientList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 0,\\n \\"maxResults\\": \\"1\\",\\n \\"page\\": 0,\\n \\"nextToken\\": \\"1\\",\\n \\"pageSize\\": 0,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]',
],
- 'GetAITeacherExpansionDialogueSuggestion' => [
- 'summary' => '拓展练小助手。',
- 'path' => '/api/v1/aiteacher/expansionPractice/suggestion',
- 'methods' => [
- 'post',
+ 'ModelRouterQueryClientTree' => [
+ 'summary' => '客户管理/获取客户树',
+ 'path' => '/api/v1/modelRouter/open/clients/tree',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
],
+ 'parameters' => [
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiResponse<List<ClientTreeDTO>>',
+ 'description' => 'OpenApiResponse<List<ClientTreeDTO>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '返回数据。客户树形结构列表',
+ 'description' => '返回数据。客户树形结构列表',
+ 'type' => 'array',
+ 'items' => ['description' => '是否删除成功', 'example' => '[]', '$ref' => '#/components/schemas/ClientTreeDTO'],
+ ],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ 'maxResults' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "id": 1,'."\n"
+ .' "name": "总公司",'."\n"
+ .' "client_uuid": "st-xxxx",'."\n"
+ .' "level": 1,'."\n"
+ .' "parent_id": null,'."\n"
+ .' "main": 0,'."\n"
+ .' "children": ['."\n"
+ .' {'."\n"
+ .' "id": 2,'."\n"
+ .' "name": "分公司1",'."\n"
+ .' "client_uuid": "st-yyyy",'."\n"
+ .' "level": 2,'."\n"
+ .' "parent_id": 1,'."\n"
+ .' "main": 1,'."\n"
+ .' "children": []'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '客户管理/获取客户树',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"discount\\": 1,\\n \\"deleteTag\\": 0,\\n \\"level\\": 1,\\n \\"parentId\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"children\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"discount\\": 1,\\n \\"deleteTag\\": 0,\\n \\"level\\": 1,\\n \\"parentId\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"children\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"discount\\": 1,\\n \\"deleteTag\\": 0,\\n \\"level\\": 1,\\n \\"parentId\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"children\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"maxResults\\": 10\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryConversation' => [
+ 'path' => '/api/v1/modelRouter/open/conversations/{id}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '259938',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '对话ID', 'description' => '对话ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ConversationDTO>',
+ 'description' => 'OpenApiSingleResponse<ConversationDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ConversationDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "title": "测试对话"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取会话详情',
+ 'summary' => '对话管理/获取对话详情',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryConversationList' => [
+ 'path' => '/api/v1/modelRouter/open/conversations',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'status',
+ 'in' => 'query',
+ 'schema' => ['title' => '状态筛选', 'description' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => 'nextToken', 'description' => '分页token,为空表示没有下一页', 'type' => 'string', 'required' => false, 'example' => '2'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求body参数',
+ 'title' => 'OpenApiPageResponse<ConversationDTO>',
+ 'description' => 'OpenApiPageResponse<ConversationDTO>',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录结构体',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'assistant' => '老师',
- 'user' => '学生',
- ],
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用。'."\n"
- .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
- .'跑题超过两次,取值会强制置为true,用于强制切换任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话任务结构体',
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
- ],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
- ],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'languageCode' => [
- 'title' => '语言编码',
- 'description' => '语言编码',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-us' => '美式英语',
- 'en-gb' => '英式英语',
- ],
- 'example' => 'en-gb',
- ],
- 'background' => [
- 'title' => '对话背景描述',
- 'description' => '对话背景描述',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.',
- ],
- 'roleInfo' => [
- 'title' => '角色设置',
- 'description' => '角色设置',
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '返回数据对象',
+ 'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'title' => '老师扮演者',
- 'description' => 'AI的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Alex',
- ],
- 'user' => [
- 'title' => '学生扮演者',
- 'description' => '用户的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Jamie',
- ],
+ 'list' => [
+ 'title' => '元素',
+ 'description' => '元素',
+ 'type' => 'array',
+ 'items' => ['title' => '元素', 'description' => '元素', 'example' => '{'."\n"
+ .' "gmt_create":"2026-03-19T18:13:30.777767+08:00",'."\n"
+ .' "id":124,'."\n"
+ .' "title":"hi",'."\n"
+ .' "gmt_modified":"2026-03-19T18:13:30.777767+08:00",'."\n"
+ .' "message_count":2,'."\n"
+ .' "model_ids":"[77]"'."\n"
+ .' },', '$ref' => '#/components/schemas/ConversationDTO'],
+ ],
+ 'total' => ['title' => '总数', 'description' => '总数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'],
+ 'page' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'maxResult' => ['title' => '分页大小,默认为20', 'description' => '分页大小,默认为20', 'type' => 'string', 'example' => '10'],
+ 'nextToken' => ['title' => 'nextToken', 'description' => 'nextToken', 'type' => 'string', 'example' => 'None'],
+ 'pageSize' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
- 'required' => true,
- ],
- 'topic' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Let\'s talk about traffic rules.',
- ],
- 'startSentence' => [
- 'title' => '开场语',
- 'description' => '开场语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Hello Lily, could you please come to the kitchen for a moment?',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
+ 'example' => '[]',
],
],
- 'required' => false,
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": [{"id": 1, "title": "测试对话"}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取会话列表',
+ 'summary' => '对话管理/获取对话列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryConversationList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ],\\n \\"total\\": 100,\\n \\"page\\": 1,\\n \\"maxResult\\": \\"10\\",\\n \\"nextToken\\": \\"None\\",\\n \\"pageSize\\": 10\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryCostModelDetail' => [
+ 'summary' => '计费管理/获取模型明细',
+ 'path' => '/api/v1/modelRouter/open/billing/cost/model-detail',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'modelId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'],
+ ],
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始时间,Unix时间戳(秒)', 'description' => '开始时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束时间,Unix时间戳(秒)', 'description' => '结束时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门ID过滤', 'description' => '部门ID过滤', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => '可选,按 API Key ID 过滤(与部门联动,需先指定 clientId)', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码,默认1', 'description' => '页码,默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量,默认20', 'description' => '每页数量,默认20', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码(优先使用)', 'description' => '页码(优先使用)', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
- 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiGetSyncDialogueSuggestionDTO>',
+ 'title' => 'OpenApiSingleResponse<CostModelDetailRespDTO>',
+ 'description' => 'OpenApiSingleResponse<CostModelDetailRespDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/CostModelDetailRespDTO'],
+ 'maxResults' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"model_id": 1, "model_name": "qwen-plus", "granularity": "hourly", "total": 24, "page": 1, "page_size": 20, "columns": [], "rows": []},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取模型用量明细',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostModelDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"columns\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"granularity\\": \\"hourly\\",\\n \\"modelId\\": 1,\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"rows\\": [\\n {\\n \\"timestamp\\": 1700000000,\\n \\"values\\": \\"\\\\\\"{\\\\\\\\\\\\\\"total_calls\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\"video_duration\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"total_amount\\\\\\\\\\\\\\":0.6,\\\\\\\\\\\\\\"image_count\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1776787200}\\\\\\"\\"\\n }\\n ],\\n \\"total\\": 100\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryCostModelList' => [
+ 'summary' => '计费管理/获取调用模型列表',
+ 'path' => '/api/v1/modelRouter/open/billing/cost/models',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始时间,Unix时间戳(秒)', 'description' => '开始时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束时间,Unix时间戳(秒)', 'description' => '结束时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'],
+ ],
+ [
+ 'name' => 'modelTypes',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型类型,逗号分隔', 'description' => '模型类型,逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'LLM,VL'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门ID过滤', 'description' => '部门ID过滤', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => '可选,按 API Key ID 过滤(与部门联动,需先指定 clientId)', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ ],
+ [
+ 'name' => 'granularity',
+ 'in' => 'query',
+ 'schema' => ['title' => '粒度:hourly/daily,默认hourly', 'description' => '自动聚合,无需传入。粒度:hourly/daily,默认hourly', 'type' => 'string', 'required' => false, 'example' => 'hourly'],
+ ],
+ [
+ 'name' => 'search',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型名称/code模糊搜索', 'description' => '模型名称/code模糊搜索', 'type' => 'string', 'required' => false, 'example' => 'qwen'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<CostQueryModelsDTO>',
+ 'description' => 'OpenApiSingleResponse<CostQueryModelsDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/CostQueryModelsDTO'],
+ 'maxResults' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"columns": [], "id_field": "model_id", "name_field": "model_name", "rows": []},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取模型用量列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostModelList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"columns\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"idField\\": \\"model_id\\",\\n \\"nameField\\": \\"model_name\\",\\n \\"rows\\": [\\n {\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelId\\": 1,\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"values\\": \\"\\\\\\"{\\\\\\\\\\\\\\"total_calls\\\\\\\\\\\\\\":21,\\\\\\\\\\\\\\"video_duration\\\\\\\\\\\\\\":210,\\\\\\\\\\\\\\"total_amount\\\\\\\\\\\\\\":126,\\\\\\\\\\\\\\"image_count\\\\\\\\\\\\\\":0}\\\\\\"\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryCostOverviewMetrics' => [
+ 'path' => '/api/v1/modelRouter/open/billing/cost/overview',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始时间,Unix时间戳(秒)', 'description' => '开始时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束时间,Unix时间戳(秒)', 'description' => '结束时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'],
+ ],
+ [
+ 'name' => 'modelTypes',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型类型,逗号分隔', 'description' => '模型类型,逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'LLM,VL'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门ID过滤', 'description' => '部门ID过滤', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ ],
+ [
+ 'name' => 'granularity',
+ 'in' => 'query',
+ 'schema' => ['title' => '粒度:hourly/daily,默认hourly', 'description' => '自动聚合,无需传入。粒度:hourly/daily,默认hourly', 'type' => 'string', 'required' => false, 'example' => 'hourly'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<List<MetricValueDTO>>',
+ 'description' => 'OpenApiSingleResponse<List<MetricValueDTO>>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'englishResult' => [
- 'title' => '小助手的英文提示',
- 'description' => '小助手的英文提示',
- 'type' => 'string',
- 'example' => 'Thanks, Lily. Do you like meat, Lily?',
- ],
- 'chineseResult' => [
- 'title' => '小助手的中文提示',
- 'description' => '小助手的中文提示',
- 'type' => 'string',
- 'example' => '谢谢莉莉.你喜欢吃肉吗,莉莉?',
- ],
- ],
+ 'type' => 'array',
+ 'items' => ['description' => '返回数据结构体', 'example' => '[]', '$ref' => '#/components/schemas/MetricValueDTO'],
'example' => '[]',
],
+ 'maxResults' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": [{"key": "total_calls", "label": "调用次数", "unit": "次", "value": 100}],'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"chineseResult\\": \\"谢谢莉莉.你喜欢吃肉吗,莉莉?\\"\\n }\\n}","type":"json"}]',
- 'title' => '获取拓展练小助手提示',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取用量概览指标',
+ 'summary' => '计费管理/获取成本概览指标',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostOverviewMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"unit\\": \\"次\\",\\n \\"value\\": 100\\n }\\n ],\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
],
- 'ExecuteAITeacherExpansionDialogueRefine' => [
- 'summary' => '拓展练根据上下文进行润色。',
- 'path' => '/api/v1/aiteacher/expansionPractice/refineByContext',
- 'methods' => [
- 'post',
+ 'ModelRouterQueryCostTrendMetrics' => [
+ 'summary' => '计费管理/获取费用趋势',
+ 'path' => '/api/v1/modelRouter/open/billing/cost/trend',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
],
+ 'parameters' => [
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '开始时间,Unix时间戳(秒)', 'description' => '开始时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '结束时间,Unix时间戳(秒)', 'description' => '结束时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'],
+ ],
+ [
+ 'name' => 'modelTypes',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型类型,逗号分隔', 'description' => '模型类型,逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'LLM,VL'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '部门ID过滤', 'description' => '部门ID过滤', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => '可选,按 API Key ID 过滤(与部门联动,需先指定 clientId)', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ ],
+ [
+ 'name' => 'granularity',
+ 'in' => 'query',
+ 'schema' => ['title' => '粒度:hourly/daily,默认hourly', 'description' => '粒度:hourly/daily,默认hourly', 'type' => 'string', 'required' => false, 'example' => 'hourly'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<CostQueryTrendDTO>',
+ 'description' => 'OpenApiSingleResponse<CostQueryTrendDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/CostQueryTrendDTO'],
+ 'maxResults' => ['description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"default_metric": "total_amount", "granularity": "hourly", "metrics": [], "points": []},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取用量趋势',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostTrendMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"defaultMetric\\": \\"total_amount\\",\\n \\"granularity\\": \\"hourly\\",\\n \\"metrics\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"points\\": [\\n {\\n \\"timestamp\\": 1700000000,\\n \\"values\\": \\"\\\\\\"{\\\\\\\\\\\\\\"total_calls\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"video_duration\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"total_amount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"model_count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"image_count\\\\\\\\\\\\\\":0}\\\\\\"\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryModel' => [
+ 'summary' => '模型管理/获取模型详情',
+ 'path' => '/api/v1/modelRouter/open/models/{id}',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '259939',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ModelDTO>',
+ 'description' => 'OpenApiSingleResponse<ModelDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "gpt-4", "type": "chat"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
+ 'title' => '获取模型信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryModelList' => [
+ 'path' => '/api/v1/modelRouter/open/models',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'keyword',
+ 'in' => 'query',
+ 'schema' => ['title' => '搜索关键字', 'description' => '搜索关键字', 'type' => 'string', 'required' => false, 'example' => 'test'],
+ ],
+ [
+ 'name' => 'status',
+ 'in' => 'query',
+ 'schema' => ['title' => '状态筛选', 'description' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页Token。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'modelType',
+ 'in' => 'query',
+ 'schema' => ['type' => 'string', 'example' => 'Chat'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求body参数。',
+ 'title' => 'OpenApiPageResponse<ModelDTO>',
+ 'description' => 'OpenApiPageResponse<ModelDTO>',
'type' => 'object',
'properties' => [
- 'records' => [
- 'title' => '对话记录',
- 'description' => '对话记录',
- 'type' => 'array',
- 'items' => [
- 'description' => '对话记录结构体',
- 'type' => 'object',
- 'properties' => [
- 'content' => [
- 'title' => '对话内容',
- 'description' => '对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Ask Mark if he has thought about what his dream job might be.',
- ],
- 'role' => [
- 'title' => '角色身份',
- 'description' => '角色身份',
- 'type' => 'string',
- 'required' => true,
- 'enumValueTitles' => [
- 'assistant' => '老师',
- 'user' => '学生',
- ],
- 'example' => 'AI:assistant;用户:user',
- ],
- 'isOnTopic' => [
- 'title' => '是否扣题',
- 'description' => '是否扣题',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '扣题:true, 不扣题:false',
- ],
- 'isOffTopicControl' => [
- 'title' => '是否跑题,带流程控制作用',
- 'description' => '是否跑题,带流程控制作用。'."\n"
- .'反映了学生的回答是否符合对话任务的设定,该参数的值来源于之前轮次的对话返回结果。此外,该参数还具有流程控制的作用。'."\n"
- .'跑题超过两次,取值会强制置为true,用于强制切换任务。',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => '跑题:true, 不跑题:false',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'items' => ['description' => '返回数据对象', 'extendType' => 'true', '$ref' => '#/components/schemas/ModelDTO'],
+ 'example' => '[]',
+ 'properties' => [
+ 'list' => [
+ 'type' => 'array',
+ 'items' => ['example' => '[]', '$ref' => '#/components/schemas/ModelDTO'],
],
- 'required' => false,
+ 'total' => ['type' => 'string', 'example' => '5'],
+ 'page' => ['type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'nextToken' => ['type' => 'string', 'example' => 'None'],
+ 'maxResults' => ['type' => 'string', 'example' => 'None'],
],
- 'required' => true,
],
- 'dialogueTasks' => [
- 'title' => '对话任务对话内容集合',
- 'description' => '对话任务对话内容集合',
+ 'maxResults' => ['title' => 'maxResults', 'description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": [{"id": 1, "name": "gpt-4", "type": "chat"}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取模型列表',
+ 'summary' => '模型管理/获取模型列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryModelList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n ],\\n \\"total\\": \\"5\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 1,\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": \\"None\\"\\n },\\n \\"maxResults\\": 10\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryNacosProviders' => [
+ 'summary' => 'Nacos配置/获取Nacos服务提供者列表。',
+ 'path' => '/api/v1/modelRouter/open/nacos/providers',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => 'nextToken', 'description' => '分页标,供分页使用,下一页token。', 'type' => 'string', 'required' => false, 'example' => '1'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiPageResponse<String>',
+ 'description' => 'OpenApiPageResponse<String>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
'type' => 'array',
'items' => [
+ 'description' => '返回数据对象',
'type' => 'object',
'properties' => [
- 'assistant' => [
- 'title' => '老师对话内容',
- 'description' => 'AI对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Why might some people think dog walking is a great job?',
- ],
- 'assistantTranslate' => [
- 'title' => '老师对话内容翻译',
- 'description' => 'AI对话内容翻译',
- 'type' => 'string',
- 'required' => false,
- 'example' => '为什么有些人认为遛狗是份好差事?',
- ],
- 'user' => [
- 'title' => '学生对话内容',
- 'description' => '用户对话内容',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'They think it\'s great because they won\'t be stuck in an office.',
- ],
- 'order' => [
- 'title' => '排序编号',
- 'description' => '排序编号',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => true,
- 'example' => '1',
+ 'name' => ['title' => '提供商名称', 'description' => '提供商名称', 'type' => 'string', 'example' => '通义千问'],
+ 'symbol' => ['title' => '提供商标识', 'description' => '提供商标识', 'type' => 'string', 'example' => 'qwen'],
+ 'baseUrl' => ['title' => '基础URL', 'description' => '基础URL', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'],
+ 'models' => [
+ 'title' => '模型列表',
+ 'description' => '模型列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '模型对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'identifier' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'example' => 'ca90f359956e94367470c38676'],
+ 'inputToken' => ['title' => '输入token限制', 'description' => '输入token限制', 'type' => 'string', 'example' => '32K'],
+ 'outputToken' => ['title' => '输出token限制', 'description' => '输出token限制', 'type' => 'string', 'example' => '8K'],
+ 'inOut' => ['title' => '输入类型/输出类型', 'type' => 'string', 'example' => 'text'],
+ 'type' => ['title' => '标识模型的功能类型/能力分类', 'type' => 'string', 'example' => 'Chat'],
+ 'extensions' => [
+ 'title' => '模型的扩展配置参数,以键值对形式存储额外的模型行为配置',
+ 'type' => 'object',
+ 'properties' => [
+ 'async' => ['title' => '异步调用标识', 'type' => 'boolean'],
+ ],
+ ],
+ ],
+ ],
],
],
- 'required' => false,
- ],
- 'required' => true,
- ],
- 'background' => [
- 'title' => '对话背景描述',
- 'description' => '对话背景描述',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'In a career counseling session, we are going to discuss our dream jobs and the responsibilities associated with them. Alex, who dreams of becoming a professional travel blogger, will share the tasks and skills required for this role, while Jamie, aspiring to be a wildlife photographer, will outline the responsibilities and challenges of capturing nature\'s moments. Both will explore how their interests align with the practical aspects of their chosen careers, discussing the potential for travel, creativity, and the impact of their work on society and the environment.',
- ],
- 'roleInfo' => [
- 'title' => '角色设置',
- 'description' => '角色设置',
- 'type' => 'object',
- 'properties' => [
- 'assistant' => [
- 'title' => '教师扮演角色',
- 'description' => 'AI的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Jane, a caring mother',
- ],
- 'user' => [
- 'title' => '学生扮演者',
- 'description' => '用户的名字',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'Lily, a friendly student',
- ],
- ],
- 'required' => true,
- ],
- 'topic' => [
- 'title' => '主题',
- 'description' => '主题',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'talk about your dream job.',
- ],
- 'languageCode' => [
- 'title' => '语言编码',
- 'description' => '语言编码',
- 'type' => 'string',
- 'required' => false,
- 'enumValueTitles' => [
- 'en-us' => '美式英语',
- 'en-gb' => '英式英语',
+ 'example' => '[]',
],
- 'example' => 'en-gb',
- ],
- 'startSentence' => [
- 'title' => '开场语',
- 'description' => '开场语',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'Hello Lily, could you please come to the kitchen for a moment?',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
+ 'example' => '[]',
],
],
- 'required' => false,
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 2,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": ["provider1", "provider2"]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '获取模型标识信息',
+ 'description' => '该接口已弃用,请勿使用',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryNacosProviders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"name\\": \\"通义千问\\",\\n \\"symbol\\": \\"qwen\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"models\\": [\\n {\\n \\"identifier\\": \\"ca90f359956e94367470c38676\\",\\n \\"inputToken\\": \\"32K\\",\\n \\"outputToken\\": \\"8K\\",\\n \\"inOut\\": \\"text\\",\\n \\"type\\": \\"Chat\\",\\n \\"extensions\\": {\\n \\"async\\": true\\n }\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryNacosTags' => [
+ 'summary' => 'Nacos配置/获取Nacos标签列表。',
+ 'path' => '/api/v1/modelRouter/open/nacos/tags',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页Token,没有下一页则为空', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => 'nextToken'],
+ ],
+ [
+ 'name' => 'configType',
+ 'in' => 'query',
+ 'schema' => ['title' => '指定要获取的 Nacos 配置类型', 'type' => 'string', 'example' => 'providers'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AITeacherOpenApiRefineDTO>',
- 'description' => 'OpenApiSingleResponse<AITeacherOpenApiRefineDTO>',
+ 'title' => 'OpenApiPageResponse<String>',
+ 'description' => 'OpenApiPageResponse<String>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
- 'type' => 'object',
- 'properties' => [
- 'result' => [
- 'title' => '润色结果',
- 'description' => '润色结果',
- 'type' => 'string',
- 'example' => 'Yes, I\'ll be right there.',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '返回结果。',
+ 'type' => 'object',
+ 'example' => '[]',
+ 'properties' => [
+ 'tagName' => ['title' => '标签名称', 'type' => 'string'],
+ 'tag' => ['title' => '标签值', 'type' => 'string'],
+ 'value' => ['title' => '模型类型值(configType=model-types时返回)', 'type' => 'string', 'example' => 'NLP'],
+ 'label' => ['title' => '模型类型显示名称(configType=model-types时返回)', 'type' => 'string', 'example' => '文本生成'],
],
],
'example' => '[]',
],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 2,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": ["tag1", "tag2"]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"result\\": \\"Yes, I\'ll be right there.\\"\\n }\\n}","type":"json"}]',
- 'title' => '执行拓展练润色',
- ],
- 'ExecuteAITeacherGrammarCheck' => [
- 'summary' => '语法检测。',
- 'path' => '/api/v1/aiteacher/common/grammarChecking',
- 'methods' => [
- 'post',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
],
- 'schemes' => [
- 'https',
+ 'title' => '获取模型标签信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryNacosTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"tagName\\": \\"\\",\\n \\"tag\\": \\"\\",\\n \\"value\\": \\"NLP\\",\\n \\"label\\": \\"文本生成\\"\\n }\\n ]\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryObservationCharts' => [
+ 'path' => '/api/v1/modelRouter/open/observation/charts',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'get',
- 'abilityTreeCode' => '259934',
- 'abilityTreeNodes' => [
- 'FEATUREaioralKM5ZTF',
- ],
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
],
'parameters' => [
[
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户ID筛选', 'description' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'API Key ID筛选', 'description' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型ID筛选', 'description' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'timeRange',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'description' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'required' => false, 'example' => '24h'],
+ ],
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '自定义开始时间', 'description' => '自定义开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '自定义结束时间', 'description' => '自定义结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-02T00:00:00Z'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
'schema' => [
- 'description' => '请求body参数',
+ 'title' => 'OpenApiSingleResponse<ObservationChartsDTO>',
+ 'description' => 'OpenApiSingleResponse<ObservationChartsDTO>',
'type' => 'object',
'properties' => [
- 'content' => [
- 'title' => '待检测的语句',
- 'description' => '待检测的语句',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'i is good',
- ],
- 'userId' => [
- 'title' => '用户Id',
- 'description' => '用户Id',
- 'type' => 'string',
- 'required' => true,
- 'example' => '886eba3702xxxxxxxxx4ba52a87a525',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ObservationChartsDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"requestCount": 100, "tokenCount": 5000},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '查看api实时监控数据',
+ 'summary' => '模型观测/获取观测图表数据',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryObservationCharts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
- 'required' => false,
],
],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"qpm\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"tpm\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"concurrency\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"callVolume\\": [],\\n \\"successRate\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"responseTime\\": []\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryObservationLogs' => [
+ 'summary' => '模型观测/获取观测日志列表。',
+ 'path' => '/api/v1/modelRouter/open/observation/logs',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户ID筛选', 'description' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'API Key ID筛选', 'description' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型ID筛选', 'description' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'timeRange',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'description' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'required' => false, 'example' => '24h'],
+ ],
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '自定义开始时间', 'description' => '自定义开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '自定义结束时间', 'description' => '自定义结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-02T00:00:00Z'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '分页token,为空表示没有下一页', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => 'nextToken'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<AiTeacherOpenApiGrammarCheckDTO>',
- 'description' => 'OpenApiSingleResponse<AiTeacherOpenApiGrammarCheckDTO>',
+ 'title' => 'OpenApiPageResponse<RequestLogDTO>',
+ 'description' => 'OpenApiPageResponse<RequestLogDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '数据对象',
+ 'title' => '返回数据',
'description' => '数据对象',
'type' => 'object',
+ 'items' => ['description' => '返回数据', 'extendType' => 'true', '$ref' => '#/components/schemas/RequestLogDTO'],
+ 'example' => '[]',
'properties' => [
- 'correctionStatus' => [
- 'title' => '语法检测结果',
- 'description' => '语法检测结果',
- 'type' => 'string',
- 'example' => 'Has_Error',
- ],
- 'errorReason' => [
- 'title' => '错误原因',
- 'description' => '错误原因',
- 'type' => 'string',
- 'example' => '暂无返回',
- ],
- 'correction' => [
- 'title' => '纠错后的语句',
- 'description' => '纠错后的语句',
- 'type' => 'string',
- 'example' => 'I am good.',
- ],
- 'analysis' => [
- 'title' => '错误分析',
- 'description' => '错误分析',
- 'type' => 'string',
- 'example' => '主语 "I" 对应的动词应该是 "am" 而不是 "is"。',
- ],
+ 'list' => [
+ 'title' => '日志数据列表',
+ 'type' => 'array',
+ 'items' => ['title' => '日志数据', '$ref' => '#/components/schemas/RequestLogDTO'],
+ ],
+ 'total' => ['title' => '分区总数', 'type' => 'integer', 'format' => 'int32', 'example' => 'None'],
+ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'pageSize' => ['title' => '每页返回数量,默认10,最多50', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'nextToken' => ['title' => '下一个查询开始的令牌。'."\n"
+ ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'maxResults' => ['title' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
],
- 'example' => '[]',
],
+ 'nextToken' => ['title' => 'nextToken', 'description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ 'maxResults' => ['title' => 'maxResults', 'description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10'],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": [{"id": 1, "requestId": "req-xxx"}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"correctionStatus\\": \\"Has_Error\\",\\n \\"errorReason\\": \\"暂无返回\\",\\n \\"correction\\": \\"I am good.\\",\\n \\"analysis\\": \\"主语 \\\\\\"I\\\\\\" 对应的动词应该是 \\\\\\"am\\\\\\" 而不是 \\\\\\"is\\\\\\"。\\"\\n }\\n}","type":"json"}]',
- 'title' => '执行语法检测',
- ],
- 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList' => [
- 'summary' => '阿里云控制台/列出阿里云控制台上可使用的服务列表。',
- 'path' => '/api/v1/aliyunConsole/queryAliyunConsoleServiceList',
- 'methods' => [
- 'get',
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '查看api调用记录',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryObservationLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"requestId\\": \\"req-xxxx\\",\\n \\"clientId\\": 1,\\n \\"apiKeyId\\": 1,\\n \\"modelId\\": 1,\\n \\"modelName\\": \\"通义千问\\",\\n \\"requestTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"responseTimeMs\\": 100,\\n \\"statusCode\\": 200,\\n \\"promptTokens\\": 100,\\n \\"completionTokens\\": 50,\\n \\"totalTokens\\": 150,\\n \\"requestBody\\": \\"{}\\",\\n \\"responseBody\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"modelCode\\": \\"qwen3-max\\",\\n \\"symbol\\": \\"qwen\\",\\n \\"clientUuid\\": \\"mt_xxxxxMYTX9\\",\\n \\"status\\": \\"success\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"usage\\": {\\n \\"promptTokens\\": 100,\\n \\"completionTokens\\": 50,\\n \\"totalTokens\\": 150,\\n \\"imageCount\\": 0,\\n \\"videoCount\\": 0,\\n \\"videoDuration\\": 0\\n }\\n }\\n ],\\n \\"total\\": 0,\\n \\"page\\": 1,\\n \\"pageSize\\": 1,\\n \\"nextToken\\": 0,\\n \\"maxResults\\": 1\\n },\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"maxResults\\": 10\\n}","type":"json"}]',
+ ],
+ 'ModelRouterQueryObservationMetrics' => [
+ 'path' => '/api/v1/modelRouter/open/observation/metrics',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页数量', 'description' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '10'],
+ ],
+ [
+ 'name' => 'pageIndex',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码', 'description' => '页码', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'],
+ ],
+ [
+ 'name' => 'orderBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序字段', 'description' => '排序字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'orderDirection',
+ 'in' => 'query',
+ 'schema' => ['title' => '排序方向', 'description' => '排序方向', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'default' => 'DESC'],
+ ],
+ [
+ 'name' => 'groupBy',
+ 'in' => 'query',
+ 'schema' => ['title' => '分组字段', 'description' => '分组字段', 'type' => 'string', 'required' => false, 'example' => 'resourceId'],
+ ],
+ [
+ 'name' => 'needTotalCount',
+ 'in' => 'query',
+ 'schema' => ['title' => '是否需要总数', 'description' => '是否需要总数', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'default' => 'true'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大结果数', 'description' => '最大结果数', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'default' => '0'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '客户ID筛选', 'description' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => 'API Key ID筛选', 'description' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'modelId',
+ 'in' => 'query',
+ 'schema' => ['title' => '模型ID筛选', 'description' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'timeRange',
+ 'in' => 'query',
+ 'schema' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'description' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'required' => false, 'example' => '24h'],
+ ],
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '自定义开始时间', 'description' => '自定义开始时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-01T00:00:00Z'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '自定义结束时间', 'description' => '自定义结束时间', 'type' => 'string', 'required' => false, 'example' => '2024-01-02T00:00:00Z'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['description' => '下一次查询的token,为空表示最后一页', 'type' => 'string', 'required' => false, 'example' => '2'],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
- 'description' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
+ 'title' => 'OpenApiPageResponse<ModelMetricsDTO>',
+ 'description' => 'OpenApiPageResponse<ModelMetricsDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'array',
- 'items' => [
- 'description' => '数据对象',
- '$ref' => '#/components/schemas/AliyunConsoleServiceInfoDTO',
- ],
+ 'items' => ['description' => '返回数据对象', '$ref' => '#/components/schemas/ModelMetricsDTO'],
'example' => '[]',
+ '$ref' => '#/components/schemas/ModelMetricsDTO',
],
],
'example' => '{'."\n"
- .' "data":['."\n"
- .' {'."\n"
- .' "freeConcurrencyCount":1,'."\n"
- .' "serviceCode":"online_oral_evaluation_call_count",'."\n"
- .' "serviceName":"口语评测-在线预付费按量调用",'."\n"
- .' "freeCount":500'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "freeConcurrencyCount":1,'."\n"
- .' "serviceCode":"online_ai_algorithm_conversation_call_count",'."\n"
- .' "serviceName":"AI算法模型-人机对话-在线按量调用",'."\n"
- .' "freeCount":500'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "success":true,'."\n"
- .' "requestId":"592A27EF-26D3-1434-98C1-97AD63337852",'."\n"
- .' "notEmpty":true,'."\n"
- .' "empty":false'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "total": 1,'."\n"
+ .' "page": 1,'."\n"
+ .' "pageSize": 10,'."\n"
+ .' "list": [{"modelId": 1, "modelName": "gpt-4", "callCount": 100}]'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
.'}',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '查看api调用报表类型信息',
+ 'summary' => '模型观测/获取观测指标数据',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryObservationMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"serviceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"serviceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"freeCount\\": 100,\\n \\"freeConcurrencyCount\\": 10,\\n \\"documentUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\",\\n \\"buyUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '服务列表查询',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"totalCalls\\": 1000,\\n \\"successRate\\": 99.5,\\n \\"avgResponseTime\\": 200.5,\\n \\"inputTokens\\": 500000,\\n \\"outputTokens\\": 300000\\n }\\n ]\\n}","type":"json"}]',
],
- 'PersonalizedTextToImageQueryPreModelInferenceJobInfo' => [
- 'summary' => '个性化文生图/查询预制模型推理任务的状态。',
- 'path' => '/api/v1/personalizedtxt2img/queryPreModelInferenceJobInfo',
- 'methods' => [
- 'get',
+ 'ModelRouterQueryUsageBreakdown' => [
+ 'summary' => '用量管理/批量查询用量明细',
+ 'path' => '/api/v1/modelRouter/open/usage/breakdown',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
],
- 'schemes' => [
- 'https',
+ 'produces' => ['application/json'],
+ 'operationType' => 'read',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'list',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
],
+ 'parameters' => [
+ [
+ 'name' => 'startTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询开始时间,Unix时间戳(秒)', 'description' => '查询开始时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'],
+ ],
+ [
+ 'name' => 'endTime',
+ 'in' => 'query',
+ 'schema' => ['title' => '查询结束时间,Unix时间戳(秒)', 'description' => '查询结束时间,Unix时间戳(秒)', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'],
+ ],
+ [
+ 'name' => 'granularity',
+ 'in' => 'query',
+ 'schema' => ['title' => '聚合粒度:hourly 或 daily', 'description' => '聚合粒度:hourly 或 daily', 'type' => 'string', 'required' => true, 'example' => 'hourly'],
+ ],
+ [
+ 'name' => 'clientId',
+ 'in' => 'query',
+ 'schema' => ['title' => '可选,按部门ID过滤', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ ],
+ [
+ 'name' => 'apiKeyId',
+ 'in' => 'query',
+ 'schema' => ['title' => '可选,按 API Key ID 过滤(与部门联动,需先指定 clientId)', 'type' => 'integer', 'format' => 'int64', 'example' => '100'],
+ ],
+ [
+ 'name' => 'page',
+ 'in' => 'query',
+ 'schema' => ['title' => '页码,默认1', 'description' => '页码,默认1', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'pageSize',
+ 'in' => 'query',
+ 'schema' => ['title' => '每页条数,默认20,最大500', 'description' => '每页条数,默认20,最大500', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'maxResults',
+ 'in' => 'query',
+ 'schema' => ['title' => '最大返回数量', 'description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'],
+ ],
+ [
+ 'name' => 'nextToken',
+ 'in' => 'query',
+ 'schema' => ['title' => '翻页标识', 'description' => '翻页标识', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx'."\n"],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<UsageBreakdownRespDTO>',
+ 'description' => 'OpenApiSingleResponse<UsageBreakdownRespDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '{}', '$ref' => '#/components/schemas/UsageBreakdownRespDTO'],
+ 'maxResults' => ['title' => '最大返回数量', 'description' => '最大返回数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'],
+ 'nextToken' => ['title' => '翻页标识', 'description' => '翻页标识', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"granularity": "hourly", "total": 100, "page": 1, "page_size": 20, "rows": []},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在,请主账号开通权限后再试,或联系管理员', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '用量汇总统计查询',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryUsageBreakdown',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"granularity\\": \\"hourly\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"total\\": 100,\\n \\"rows\\": [\\n {\\n \\"summaryTime\\": 1700000000,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"modelType\\": \\"llm\\",\\n \\"clientId\\": 0,\\n \\"clientName\\": \\"研发部\\",\\n \\"apiKeyId\\": 0,\\n \\"apiKeyName\\": \\"默认密钥\\",\\n \\"metrics\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"value\\": 100\\n }\\n ]\\n }\\n ]\\n },\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]',
+ ],
+ 'ModelRouterSaveFlowConfig' => [
+ 'path' => '/api/v1/modelRouter/open/flow-config',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'get',
+ 'operationType' => 'create',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
],
'parameters' => [
[
- 'name' => 'inferenceJobId',
- 'in' => 'query',
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
'schema' => [
- 'title' => '推理任务编号',
- 'description' => '推理任务编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'girl-xxxx-xxxx-xxxx-xxxx',
+ 'title' => '流控配置写入请求',
+ 'type' => 'object',
+ 'properties' => [
+ 'modelId' => ['title' => '模型ID', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '607', 'description' => ''],
+ 'smoothFlowEnabled' => ['title' => '是否启用平滑流控', 'type' => 'boolean', 'example' => 'true', 'description' => ''],
+ 'rpm' => ['title' => '每分钟请求数限制(RPM)', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => ''],
+ 'tpm' => ['title' => '每分钟Token数限制(TPM)', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'description' => ''],
+ ],
+ 'description' => '',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<PreModelInferenceJobInfoDTO>',
- 'description' => 'OpenApiSingleResponse<PreModelInferenceJobInfoDTO>',
+ 'title' => 'OpenApiSingleResponse<FlowConfigResp>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'requestId' => ['title' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'description' => ''],
+ 'success' => ['title' => '是否成功', 'type' => 'boolean', 'example' => 'true', 'description' => ''],
+ 'errCode' => ['title' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'description' => ''],
+ 'errMessage' => ['title' => '错误信息', 'type' => 'string', 'example' => '未知错误', 'description' => ''],
+ 'httpStatusCode' => ['title' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'description' => ''],
+ 'data' => [
+ 'title' => '返回数据',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => '流控配置ID', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'description' => ''],
+ 'modelId' => ['title' => '模型ID', 'type' => 'integer', 'format' => 'int32', 'example' => '607', 'description' => ''],
+ 'smoothFlowEnabled' => ['title' => '是否启用平滑流控', 'type' => 'boolean', 'example' => 'true', 'description' => ''],
+ 'rpm' => ['title' => '每分钟请求数限制(RPM)', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => ''],
+ 'tpm' => ['title' => '每分钟Token数限制(TPM)', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'description' => ''],
+ 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2026-04-27T18:28:57.987356+08:00', 'description' => ''],
+ 'gmtModified' => ['title' => '修改时间', 'type' => 'string', 'example' => '2026-04-27T18:28:57.987356+08:00', 'description' => ''],
+ ],
+ 'description' => '',
],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {'."\n"
+ .' "id": 6,'."\n"
+ .' "model_id": 607,'."\n"
+ .' "smooth_flow_enabled": true,'."\n"
+ .' "rpm": 100,'."\n"
+ .' "tpm": 10000,'."\n"
+ .' "gmt_create": "2026-04-27T18:28:57.987356+08:00",'."\n"
+ .' "gmt_modified": "2026-04-27T18:28:57.987356+08:00"'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ 'description' => '',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 200 => [
+ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => '鉴权失败-组织不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'summary' => '流控管理/写入流控配置',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 6,\\n \\"modelId\\": 607,\\n \\"smoothFlowEnabled\\": true,\\n \\"rpm\\": 100,\\n \\"tpm\\": 10000,\\n \\"gmtCreate\\": \\"2026-04-27T18:28:57.987356+08:00\\",\\n \\"gmtModified\\": \\"2026-04-27T18:28:57.987356+08:00\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterUpdateBillingRule' => [
+ 'path' => '/api/v1/modelRouter/open/billing/rules/{id}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '计费规则ID', 'description' => '计费规则ID(必填)', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'title' => '计费规则更新请求',
+ 'description' => '计费规则更新请求',
+ 'type' => 'object',
+ 'properties' => [
+ 'billingType' => ['title' => '计费类型', 'description' => '计费类型:configurable', 'type' => 'string', 'required' => false, 'example' => 'configurable'],
+ 'pricingConfig' => ['title' => '计费配置JSON', 'description' => '计费配置JSON'."\n"
+ .'1. Token 阶梯计费(token_tiered)'."\n"
+ .'适用于 Chat 类模型。按输入 Token 数量分阶梯计价,支持常规模式、思考模式、缓存命中三种价格维度。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "tiers": ['."\n"
+ .' {'."\n"
+ .' "min_tokens": 0,'."\n"
+ .' "max_tokens": 32000,'."\n"
+ .' "input_price": 2.5,'."\n"
+ .' "output_price": 10,'."\n"
+ .' "thinking_input_price": 2.5,'."\n"
+ .' "thinking_output_price": 10,'."\n"
+ .' "cached_input_price": 2.5'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "min_tokens": 32000,'."\n"
+ .' "max_tokens": 128000,'."\n"
+ .' "input_price": 4,'."\n"
+ .' "output_price": 16,'."\n"
+ .' "thinking_input_price": 4,'."\n"
+ .' "thinking_output_price": 16,'."\n"
+ .' "cached_input_price": 4'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'tiers array 是 阶梯定价数组,至少一个元素 -'."\n"
+ .'tiers[].min_tokens integer 是 当前阶梯 Token 数量下限(含) Token'."\n"
+ .'tiers[].max_tokens integer 是 当前阶梯 Token 数量上限(不含),0 表示不限 Token'."\n"
+ .'tiers[].input_price number 是 常规模式输入 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].output_price number 是 常规模式输出 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].thinking_input_price number 否 思考模式输入 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].thinking_output_price number 否 思考模式输出 Token 单价 元 / 百万 Token'."\n"
+ .'tiers[].cached_input_price number 否 缓存命中时输入 Token 单价 元 / 百万 Token'."\n"
+ .'thinking_mode_tiers array 否 思考模式专用阶梯,结构与 tiers 相同。当请求中存在 reasoning_tokens 且该字段非空时,优先使用此阶梯替代 tiers -'."\n"
+ .'约束:'."\n"
+ .'第一个阶梯的 min_tokens 必须为 0'."\n"
+ .'非最后一个阶梯的 max_tokens 必须大于 min_tokens'."\n"
+ .'相邻阶梯必须连续衔接(前一阶梯 max_tokens = 后一阶梯 min_tokens),不允许重叠或间隙'."\n"
+ ."\n"
+ .'2. 按图片计费(per_image)'."\n"
+ .'适用于 ImageGeneration、ImageEdit 类模型。按生成/处理图片的张数计价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "price_per_image": 0.2'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'price_per_image number 是 每张图片的计费单价 元 / 张'."\n"
+ ."\n"
+ .'3. 视频矩阵计费(video_matrix)'."\n"
+ .'适用于 VideoGeneration、VideoImageGeneration 类模型。按视频分辨率和是否有音频两个维度组合定价。'."\n"
+ .'注意: 前端交互时使用 matrix 字段,但调用 API 保存时需使用 tiers 字段(matrix 会在服务端自动转换)。以下给出的是 API 侧的标准格式。'."\n"
+ .'JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "tiers": ['."\n"
+ .' {'."\n"
+ .' "resolution": 480,'."\n"
+ .' "has_audio": 0,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "resolution": 480,'."\n"
+ .' "has_audio": 1,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "resolution": 720,'."\n"
+ .' "has_audio": 0,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "resolution": 720,'."\n"
+ .' "has_audio": 1,'."\n"
+ .' "price_per_second": 0.24'."\n"
+ .' }'."\n"
+ .' ],'."\n"
+ .' "default_price_per_second": 0.24'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'tiers array 是 视频矩阵定价数组 -'."\n"
+ .'tiers[].resolution integer 是 视频分辨率,取值:480、720、1080 像素高度(p)'."\n"
+ .'tiers[].has_audio integer 是 是否包含音频,取值:0(无声)、1(有声) -'."\n"
+ .'tiers[].price_per_second number 是 该组合下的每秒单价 元 / 秒'."\n"
+ .'default_price_per_second number 否 未匹配到矩阵项时的默认每秒单价 元 / 秒'."\n"
+ .'约束:'."\n"
+ .'resolution 仅支持 480p、720p、1080p'."\n"
+ .'resolution + has_audio 组合不可重复'."\n"
+ ."\n"
+ .'4. 按时长计费(per_duration)'."\n"
+ .'适用于 ASR(语音识别)类模型。按音频时长计价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "price_per_unit": 0.00022'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'price_per_unit number 是 音频每秒计费单价 元 / 秒'."\n"
+ ."\n"
+ .'5. 按字符计费(per_character)'."\n"
+ .'适用于 TTS(语音合成)类模型。按合成文本的字符数计价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "price_per_unit": 0.8'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'price_per_unit number 是 每万字符计费单价 元 / 万字符'."\n"
+ ."\n"
+ .'6. Token 统一计费(token_flat)'."\n"
+ .'适用于 Embedding、Rerank、MultimodalEmbedding、MultimodalRerank 类模型。不区分阶梯,按统一单价计费。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "input_price": 0.5,'."\n"
+ .' "multimodal_input_price": 0.5'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'input_price number 是 纯文本输入 Token 单价 元 / 百万 Token'."\n"
+ .'multimodal_input_price number 否 多模态输入 Token 单价 元 / 百万 Token'."\n"
+ ."\n"
+ .'7. 全模态多维度计费(omni_multimodal)'."\n"
+ .'适用于 ChatFullmodal 类全模态模型(如 qwen3.5-omni-plus)。对文本、音频、图片、视频等不同模态的输入和输出分别定价。JSON 格式:'."\n"
+ .'json'."\n"
+ .'{'."\n"
+ .' "text_input_price": 7,'."\n"
+ .' "audio_input_price": 53,'."\n"
+ .' "image_input_price": 7,'."\n"
+ .' "video_input_price": 7,'."\n"
+ .' "text_output_price": 40,'."\n"
+ .' "audio_output_price": 213,'."\n"
+ .' "multi_text_output_price": 0'."\n"
+ .'}'."\n"
+ .'字段说明:'."\n"
+ .'字段 类型 必填 语义 单位'."\n"
+ .'text_input_price number 是 文本输入 Token 单价 元 / 百万 Token'."\n"
+ .'audio_input_price number 是 音频输入 Token 单价 元 / 百万 Token'."\n"
+ .'image_input_price number 否 图片输入 Token 单价 元 / 百万 Token'."\n"
+ .'video_input_price number 否 视频输入 Token 单价 元 / 百万 Token'."\n"
+ .'text_output_price number 是 文本输出 Token 单价 元 / 百万 Token'."\n"
+ .'audio_output_price number 否 音频输出 Token 单价 元 / 百万 Token'."\n"
+ .'multi_text_output_price number 否 多模态输入后的文本输出 Token 单价(当输入包含图片/音频/视频时,文本输出的单独计价) 元 / 百万 Token'."\n"
+ .'计费类型自动映射关系'."\n"
+ .'模型类型(model_type) 自动识别的计费类型 pricingConfig 关键识别字段'."\n"
+ .'Chat token_tiered 存在 tiers 字段'."\n"
+ .'ChatFullmodal omni_multimodal 存在 text_input_price 或 audio_input_price'."\n"
+ .'ImageGeneration / ImageEdit per_image 存在 price_per_image'."\n"
+ .'VideoGeneration / VideoImageGeneration video_matrix 存在 tiers 且 tier 元素含 resolution'."\n"
+ .'ASR per_duration 存在 price_per_unit(ASR 场景)'."\n"
+ .'TTS per_character 存在 price_per_unit(TTS 场景)'."\n"
+ .'Embedding / Rerank / MultimodalEmbedding / MultimodalRerank token_flat 存在 input_price', 'type' => 'any', 'required' => false, 'example' => '{'."\n"
+ .' "tiers": ['."\n"
+ .' {'."\n"
+ .' "min_tokens": 0,'."\n"
+ .' "max_tokens": 32000,'."\n"
+ .' "input_price": 2.5,'."\n"
+ .' "output_price": 2.5,'."\n"
+ .' "thinking_output_price": 10,'."\n"
+ .' "cached_input_price": 1.25'."\n"
+ .' },'."\n"
+ .' {'."\n"
+ .' "min_tokens": 32000,'."\n"
+ .' "max_tokens": 0,'."\n"
+ .' "input_price": 1.25,'."\n"
+ .' "output_price": 1.25,'."\n"
+ .' "thinking_output_price": 5,'."\n"
+ .' "cached_input_price": 0.625'."\n"
+ .' }'."\n"
+ .' ]'."\n"
+ .'}'],
+ 'effectiveTime' => ['title' => '生效时间,RFC3339格式', 'description' => '生效时间,RFC3339格式', 'type' => 'string', 'required' => false, 'example' => '2024-01-01T00:00:00Z'],
+ 'expireTime' => ['title' => '过期时间,RFC3339格式', 'description' => '过期时间,RFC3339格式', 'type' => 'string', 'required' => false, 'example' => '2025-01-01T00:00:00Z'],
+ 'status' => ['title' => '状态,用于启停', 'description' => '状态,用于启停', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'version' => ['title' => '计费规则版本号', 'description' => '计费规则版本号', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<BillingRuleResp>',
+ 'description' => 'OpenApiSingleResponse<BillingRuleResp>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
- 'title' => '数据对象',
- 'description' => '数据对象',
+ 'title' => '返回数据',
+ 'description' => '返回数据',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'description' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'description' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'description' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
- 'jobStatus' => [
- 'title' => '模型推理任务状态',
- 'description' => '模型推理任务状态',
- 'type' => 'string',
- 'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'description' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
- ],
- 'resultImageUrl' => [
- 'title' => '模型推理任务结果列表',
- 'description' => '模型推理任务结果列表',
- 'type' => 'array',
- 'items' => [
- 'description' => '图片资源编号',
- 'type' => 'string',
- 'example' => '0000.png',
- ],
- 'example' => '0000.png',
- ],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'description' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'id' => ['title' => '规则ID', 'description' => '规则ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelId' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'],
+ 'modelCode' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'example' => 'qwen-plus'],
+ 'modelName' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'example' => '通义千问Plus'],
+ 'modelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'example' => 'chat'],
+ 'symbol' => ['title' => '厂商标识', 'description' => '厂商标识', 'type' => 'string', 'example' => 'alibaba'],
+ 'billingType' => ['title' => '计费类型', 'description' => '计费类型', 'type' => 'string', 'example' => 'token_tiered'],
+ 'pricingConfig' => ['title' => '计费配置', 'description' => '计费配置', 'type' => 'any', 'example' => '{}'],
+ 'effectiveTime' => ['title' => '生效时间', 'description' => '生效时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'expireTime' => ['title' => '过期时间', 'description' => '过期时间', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'],
+ 'version' => ['title' => '版本号', 'description' => '版本号', 'type' => 'integer', 'format' => 'int32', 'example' => '1'],
+ 'deleteTag' => ['title' => '删除标记', 'description' => '删除标记', 'type' => 'integer', 'format' => 'int32', 'example' => '0'],
+ 'gmtCreate' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
+ 'gmtModified' => ['title' => '修改时间', 'description' => '修改时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'],
],
- 'example' => '[]',
],
],
- 'example' => '{"data":{"jobStatus":"WAIT_SCHEDULE","modelId":"girl_6dcc62b4-4019-11ef-a7fd-954b0578482b","createTime":"2024-07-12T14:44:19.362931","promptId":"2a3d91c0-401a-11ef-a7fd-954b0578482b","id":"20"},"success":true,"errCode":null,"errMessage":null,"requestId":"048F9250-03AD-19F3-B07D-D2879CF34AF1"}',
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "billing_type": "token_tiered"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
'errorCodes' => [
- 400 => [
- [
- 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '必要参数没有找到',
+ 200 => [
+ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''],
+ ['errorCode' => 'B.Billing.RuleNotFoundException', 'errorMessage' => 'B.Billing.RuleNotFoundException.', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => '鉴权失败-组织不存在'],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '计费管理/更新计费规则',
+ 'summary' => '计费管理/更新计费规则',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问Plus\\",\\n \\"modelType\\": \\"chat\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"billingType\\": \\"token_tiered\\",\\n \\"pricingConfig\\": \\"{}\\",\\n \\"effectiveTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"expireTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"version\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterUpdateClient' => [
+ 'path' => '/api/v1/modelRouter/open/clients/{id}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '客户ID', 'description' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '客户名称', 'description' => '客户名称', 'type' => 'string', 'required' => false, 'example' => '我的客户'],
+ 'address' => ['title' => '公司地址', 'description' => '公司地址', 'type' => 'string', 'required' => false, 'example' => '杭州市'],
+ 'contact' => ['title' => '联系方式', 'description' => '联系方式', 'type' => 'string', 'required' => false, 'example' => '13800138000'],
+ 'remark' => ['title' => '备注信息', 'description' => '备注信息', 'type' => 'string', 'required' => false, 'example' => '备注'],
+ 'discount' => ['type' => 'number', 'format' => 'double', 'example' => '1.0'],
+ 'status' => ['title' => '状态', 'description' => '状态', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'allowedModels' => ['title' => '允许的模型ID列表,逗号分隔,空表示全部', 'description' => '允许的模型ID列表,逗号分隔,空表示全部', 'type' => 'string', 'required' => false, 'example' => '1,2,3'],
+ ],
+ 'required' => false,
],
],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ClientDTO>',
+ 'description' => 'OpenApiSingleResponse<ClientDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ClientDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "更新后客户"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '更新客户信息',
+ 'summary' => '客户管理/更新客户',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateClient',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterUpdateConversation' => [
+ 'path' => '/api/v1/modelRouter/open/conversations/{id}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
[
- [
- 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '资源没有找到',
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '对话ID', 'description' => '对话ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'title' => ['title' => '对话标题', 'description' => '对话标题', 'type' => 'string', 'required' => false, 'example' => '我的对话'],
+ 'chatData' => ['title' => '对话数据JSON,包含各模型的消息记录', 'description' => '对话数据JSON,包含各模型的消息记录', 'type' => 'string', 'required' => false, 'example' => '{"messages":[{"role":"user","content":"你好"}]}'],
+ 'messageCount' => ['title' => '消息数量', 'description' => '消息数量', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'],
+ 'modelIds' => ['title' => '模型ID列表,JSON数组字符串', 'description' => '模型ID列表,JSON数组字符串', 'type' => 'string', 'required' => false, 'example' => '[1,2,3]'],
+ ],
+ 'required' => false,
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ConversationDTO>',
+ 'description' => 'OpenApiSingleResponse<ConversationDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ConversationDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "title": "更新后对话"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '更新会话信息',
+ 'summary' => '对话管理/更新对话',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"0000.png\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
- 'title' => '查询预置模型推理任务信息',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]',
+ ],
+ 'ModelRouterUpdateModel' => [
+ 'summary' => '模型管理/更新模型',
+ 'path' => '/api/v1/modelRouter/open/models/{id}',
+ 'methods' => ['put'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'consumes' => ['application/json'],
+ 'produces' => ['application/json'],
+ 'operationType' => 'write',
+ 'deprecated' => false,
+ 'systemTags' => [
+ 'operationType' => 'update',
+ 'riskType' => 'none',
+ 'chargeType' => 'free',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ ],
+ 'parameters' => [
+ [
+ 'name' => 'id',
+ 'in' => 'path',
+ 'schema' => ['title' => '模型ID', 'description' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ ],
+ [
+ 'name' => 'body',
+ 'in' => 'body',
+ 'style' => 'json',
+ 'schema' => [
+ 'description' => '请求body参数。',
+ 'type' => 'object',
+ 'properties' => [
+ 'name' => ['title' => '模型名称', 'description' => '模型名称', 'type' => 'string', 'required' => false, 'example' => '通义千问'],
+ 'description' => ['title' => '模型描述', 'description' => '模型描述', 'type' => 'string', 'required' => false, 'example' => '通义千问大模型'],
+ 'status' => ['title' => '状态', 'description' => '状态', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'symbol' => ['title' => '厂商symbol', 'description' => '厂商symbol', 'type' => 'string', 'required' => false, 'example' => 'alibaba'],
+ 'tags' => ['title' => '标签,逗号分隔', 'description' => '标签,逗号分隔', 'type' => 'string', 'required' => false, 'example' => 'chat,NLP'],
+ 'modelId' => ['title' => '模型标识', 'description' => '模型标识', 'type' => 'string', 'required' => false, 'example' => 'qwen-turbo'],
+ 'modelType' => ['title' => '模型类型', 'description' => '模型类型', 'type' => 'string', 'required' => false, 'example' => 'Chat'],
+ 'apiKey' => ['title' => 'API Key', 'description' => 'API Key', 'type' => 'string', 'required' => false, 'example' => 'sk-xxxx'],
+ 'baseUrl' => ['title' => 'Base URL', 'description' => 'Base URL', 'type' => 'string', 'required' => false, 'example' => 'https://dashscope.aliyuncs.com'],
+ 'maxInputLength' => ['title' => '最大输入长度', 'description' => '最大输入长度', 'type' => 'string', 'required' => false, 'example' => '8192'],
+ 'maxOutputLength' => ['title' => '最大输出长度', 'description' => '最大输出长度', 'type' => 'string', 'required' => false, 'example' => '2048'],
+ ],
+ 'required' => false,
+ 'title' => '请求body参数。',
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'OpenApiSingleResponse<ModelDTO>',
+ 'description' => 'OpenApiSingleResponse<ModelDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => ['title' => '数据对象', 'description' => '数据对象', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO'],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data": {"id": 1, "name": "更新后模型"},'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 403 => [
+ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'title' => '更新模型信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n}","type":"json"}]',
],
'PersonalizedTextToImageAddInferenceJob' => [
'summary' => '个性化文生图/基于一个预训练模型创建图片推理任务。',
'path' => '/api/v1/personalizedtxt2img/addPreModelInferenceJob',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'create',
- 'tenantRelevance' => 'publicInformation',
- ],
+ 'systemTags' => ['operationType' => 'create', 'tenantRelevance' => 'publicInformation'],
'parameters' => [
[
'name' => 'body',
@@ -8753,59 +10374,20 @@
'title' => '包含图片链接的列表, 可包含单张或多张图片的链接, 如["url_1", "url_2", ...]',
'description' => '包含图片链接的列表, 可包含单张或多张图片的链接, 如["url_1", "url_2", ...]',
'type' => 'array',
- 'items' => [
- 'description' => '图片地址,须确保能够有效访问,否则页面无法展示',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg',
- ],
- 'required' => true,
- ],
- 'trainSteps' => [
- 'title' => '模型训练任务训练步骤',
- 'description' => '模型训练任务训练步骤',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '800',
- ],
- 'prompt' => [
- 'title' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"',
- 'description' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"',
- 'type' => 'string',
+ 'items' => ['description' => '图片地址,须确保能够有效访问,否则页面无法展示', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'],
'required' => true,
- 'example' => 'a <special-token> in the snow',
- ],
- 'imageNumber' => [
- 'title' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理',
- 'description' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'seed' => [
- 'title' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。',
- 'description' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
- 'strength' => [
- 'title' => '表示输入的参考图像对生成过程的影响强度,'."\n"
- .'取值范围是 [0.3, 0.4, 0.5, 0.6, 0.7, 0.8],'."\n"
- .'值越小,表示参考图像对生成的影响强度越低,相应的,文本对生成过程的影响强度越高。'."\n"
- .'默认是0.5,一般情况不需要设置,保持默认。',
- 'description' => '表示输入的参考图像对生成过程的影响强度,'."\n"
- .'取值范围是 [0.3, 0.4, 0.5, 0.6, 0.7, 0.8],'."\n"
- .'值越小,表示参考图像对生成的影响强度越低,相应的,文本对生成过程的影响强度越高。'."\n"
- .'默认是0.5,一般情况不需要设置,保持默认。',
- 'type' => 'number',
- 'format' => 'double',
- 'required' => false,
- 'example' => '1',
],
+ 'trainSteps' => ['title' => '模型训练任务训练步骤', 'description' => '模型训练任务训练步骤', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800'],
+ 'prompt' => ['title' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"', 'description' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"', 'type' => 'string', 'required' => true, 'example' => 'a <special-token> in the snow'],
+ 'imageNumber' => ['title' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理', 'description' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'seed' => ['title' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。', 'description' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
+ 'strength' => ['title' => '表示输入的参考图像对生成过程的影响强度,'."\n"
+ .'取值范围是 [0.3, 0.4, 0.5, 0.6, 0.7, 0.8],'."\n"
+ .'值越小,表示参考图像对生成的影响强度越低,相应的,文本对生成过程的影响强度越高。'."\n"
+ .'默认是0.5,一般情况不需要设置,保持默认。', 'description' => '表示输入的参考图像对生成过程的影响强度,'."\n"
+ .'取值范围是 [0.3, 0.4, 0.5, 0.6, 0.7, 0.8],'."\n"
+ .'值越小,表示参考图像对生成的影响强度越低,相应的,文本对生成过程的影响强度越高。'."\n"
+ .'默认是0.5,一般情况不需要设置,保持默认。', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '1'],
],
'required' => false,
],
@@ -8818,100 +10400,35 @@
'description' => 'OpenApiSingleResponse<PreModelInferenceJobInfoDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'description' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'description' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'description' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
+ 'id' => ['title' => '模型推理任务id', 'description' => '模型推理任务id', 'type' => 'string', 'example' => '3220'],
+ 'promptId' => ['title' => 'promptId', 'description' => 'promptId', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'],
+ 'modelId' => ['title' => '模型Id', 'description' => '模型Id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
'jobStatus' => [
'title' => '模型推理任务状态',
'description' => '模型推理任务状态',
'type' => 'string',
'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'description' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型推理任务进度', 'description' => '模型推理任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'resultImageUrl' => [
'title' => '模型推理任务结果列表',
'description' => '模型推理任务结果列表',
'type' => 'array',
- 'items' => [
- 'description' => '模型推理任务结果列表',
- 'type' => 'string',
- 'example' => '0000.png',
- ],
+ 'items' => ['description' => '模型推理任务结果列表', 'type' => 'string', 'example' => '0000.png'],
'example' => '0000.png',
],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'description' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'createTime' => ['title' => '模型推理任务创建时间', 'description' => '模型推理任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
'example' => '[]',
],
@@ -8926,36 +10443,41 @@
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"0000.png\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
'title' => '添加预置模型推理任务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:PersonalizedTextToImageAddPreModelInferenceJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'PersonalizedTextToImageQueryImageAsset' => [
'summary' => '个性化文生图/通过唯一的图片编号获取图片内容。',
'path' => '/api/v1/personalizedtxt2img/queryImageAssetFromImageId',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'imageId',
'in' => 'query',
- 'schema' => [
- 'title' => '图片编号',
- 'description' => '图片编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0000.png',
- ],
+ 'schema' => ['title' => '图片编号', 'description' => '图片编号', 'type' => 'string', 'required' => true, 'example' => '0000.png'],
],
[
'name' => 'encodeFormat',
@@ -8966,227 +10488,151 @@
'type' => 'string',
'required' => false,
'example' => 'base64',
- 'enum' => [
- 'base64',
- ],
+ 'enum' => ['base64'],
],
],
],
'responses' => [
200 => [
- 'schema' => [
- 'title' => 'Object',
- 'description' => 'Object',
- 'type' => 'any',
- 'example' => 'BinaryData',
- ],
+ 'schema' => ['title' => 'Object', 'description' => 'Object', 'type' => 'any', 'example' => 'BinaryData'],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '必要参数没有找到',
- ],
+ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
[
- [
- 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '资源没有找到',
- ],
+ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]',
'title' => '图片资源获取',
- ],
- 'Personalizedtxt2imgQueryInferenceJobInfo' => [
- 'summary' => '个性化文生图/查询模型推理任务的状态和结果信息。',
- 'path' => '/api/v1/personalizedtxt2img/queryInferenceJobInfo',
- 'methods' => [
- 'get',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:PersonalizedTextToImageQueryImageAsset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'PersonalizedTextToImageQueryPreModelInferenceJobInfo' => [
+ 'summary' => '个性化文生图/查询预制模型推理任务的状态。',
+ 'path' => '/api/v1/personalizedtxt2img/queryPreModelInferenceJobInfo',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'inferenceJobId',
'in' => 'query',
- 'schema' => [
- 'title' => '推理任务编号',
- 'description' => '推理任务编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '180',
- ],
+ 'schema' => ['title' => '推理任务编号', 'description' => '推理任务编号', 'type' => 'string', 'required' => true, 'example' => 'girl-xxxx-xxxx-xxxx-xxxx'],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiSingleResponse<InferenceJobInfoDTO>',
- 'description' => '开放接口单对象响应体',
+ 'title' => 'OpenApiSingleResponse<PreModelInferenceJobInfoDTO>',
+ 'description' => 'OpenApiSingleResponse<PreModelInferenceJobInfoDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'description' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'description' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'description' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
+ 'id' => ['title' => '模型推理任务id', 'description' => '模型推理任务id', 'type' => 'string', 'example' => '3220'],
+ 'promptId' => ['title' => 'promptId', 'description' => 'promptId', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'],
+ 'modelId' => ['title' => '模型Id', 'description' => '模型Id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
'jobStatus' => [
'title' => '模型推理任务状态',
'description' => '模型推理任务状态',
'type' => 'string',
'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'description' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型推理任务进度', 'description' => '模型推理任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'resultImageUrl' => [
'title' => '模型推理任务结果列表',
'description' => '模型推理任务结果列表',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['description' => '图片资源编号', 'type' => 'string', 'example' => '0000.png'],
'example' => '0000.png',
],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'description' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'createTime' => ['title' => '模型推理任务创建时间', 'description' => '模型推理任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
'example' => '[]',
],
],
- 'example' => '{"success":true,"errCode":null,"errMessage":null,"requestId":"8be53f1f-ad1d-4548-b309-ab1140827833","data":{"id":"1","promptId":"prompt_id-xxxx-xxxx-xxxx-xxxx","modelId":"model_id-xxxx-xxxx-xxxx-xxxx","jobStatus":"NOT_START","resultImageUrl":null,"createUserId":"109988888888","createTime":"2024-06-28T11:02:32.441184"}}',
+ 'example' => '{"data":{"jobStatus":"WAIT_SCHEDULE","modelId":"girl_6dcc62b4-4019-11ef-a7fd-954b0578482b","createTime":"2024-07-12T14:44:19.362931","promptId":"2a3d91c0-401a-11ef-a7fd-954b0578482b","id":"20"},"success":true,"errCode":null,"errMessage":null,"requestId":"048F9250-03AD-19F3-B07D-D2879CF34AF1"}',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '必要参数没有找到',
- ],
+ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
[
- [
- 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '资源没有找到',
- ],
+ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"0000.png\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询预置模型推理任务信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:PersonalizedTextToImageQueryPreModelInferenceJobInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
- 'title' => '个性化文生图/查询模型推理任务的状态和结果信息',
],
'Personalizedtxt2imgAddInferenceJob' => [
'summary' => '个性化文生图/基于一个模型创建图片推理任务。',
'path' => '/api/v1/personalizedtxt2img/addInferenceJob',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9196,9 +10642,7 @@
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '226451',
- 'abilityTreeNodes' => [
- 'FEATUREaioral4PZ00K',
- ],
+ 'abilityTreeNodes' => ['FEATUREaioral4PZ00K'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -9210,36 +10654,10 @@
'description' => '请求体对象。',
'type' => 'object',
'properties' => [
- 'modelId' => [
- 'title' => '模型训练任务id, 指定要用哪个模型进行推理',
- 'description' => '模型训练任务id, 指定要用哪个模型进行推理',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx-xxxx-xxxx',
- ],
- 'prompt' => [
- 'title' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"',
- 'description' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'a <special-token> in the snow',
- ],
- 'imageNumber' => [
- 'title' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理',
- 'description' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
- ],
- 'seed' => [
- 'title' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。',
- 'description' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。',
- 'type' => 'integer',
- 'format' => 'int64',
- 'required' => false,
- 'example' => '1',
- ],
+ 'modelId' => ['title' => '模型训练任务id, 指定要用哪个模型进行推理', 'description' => '模型训练任务id, 指定要用哪个模型进行推理', 'type' => 'string', 'required' => true, 'example' => 'xxxx-xxxx-xxxx'],
+ 'prompt' => ['title' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"', 'description' => '英文prompt描述生成的图像, 要生成的角色用<special-token>替代, 如“a man in the snow”要改为"a <special-token> in the snow", "a photo of a girl"改为"a photo of a <special-token>"', 'type' => 'string', 'required' => true, 'example' => 'a <special-token> in the snow'],
+ 'imageNumber' => ['title' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理', 'description' => '要生成图片的数量。注意: 由于测试环境资源限制,一次最多生成10张图片, 该值大于10按10处理', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'],
+ 'seed' => ['title' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。', 'description' => '随机数种子,该种子固定时可以得到相同的生成图像,确保结果的可复现性,注意: 输入值需处于[-1, 2147483647],输入值在该区间外或者不输入时将自动生成一个合适的种子。', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'],
],
'required' => false,
],
@@ -9252,98 +10670,35 @@
'description' => '开放接口单对象响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'description' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'description' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'description' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
+ 'id' => ['title' => '模型推理任务id', 'description' => '模型推理任务id', 'type' => 'string', 'example' => '3220'],
+ 'promptId' => ['title' => 'promptId', 'description' => 'promptId', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'],
+ 'modelId' => ['title' => '模型Id', 'description' => '模型Id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
'jobStatus' => [
'title' => '模型推理任务状态',
'description' => '模型推理任务状态',
'type' => 'string',
'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'description' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型推理任务进度', 'description' => '模型推理任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'resultImageUrl' => [
'title' => '模型推理任务结果列表',
'description' => '模型推理任务结果列表',
'type' => 'array',
- 'items' => [
- 'type' => 'string',
- ],
+ 'items' => ['type' => 'string', 'description' => ''],
'example' => '0000.png',
],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'description' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'createTime' => ['title' => '模型推理任务创建时间', 'description' => '模型推理任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
'example' => '[]',
],
@@ -9354,16 +10709,32 @@
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
'title' => '个性化文生图/基于一个模型创建图片推理任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-05T08:54:21.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgAddInferenceJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'Personalizedtxt2imgAddModelTrainJob' => [
'summary' => '个性化文生图/创建一个模型训练任务。',
'path' => '/api/v1/personalizedtxt2img/addModelTrainJob',
- 'methods' => [
- 'post',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9373,9 +10744,7 @@
'systemTags' => [
'operationType' => 'create',
'abilityTreeCode' => '226450',
- 'abilityTreeNodes' => [
- 'FEATUREaioral4PZ00K',
- ],
+ 'abilityTreeNodes' => ['FEATUREaioral4PZ00K'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [
@@ -9387,40 +10756,16 @@
'description' => '请求结构。',
'type' => 'object',
'properties' => [
- 'name' => [
- 'title' => '模型训练任务名称',
- 'description' => '模型训练任务名称',
- 'type' => 'string',
- 'required' => true,
- 'example' => '熊猫图片生成',
- ],
- 'objectType' => [
- 'title' => '图片中目标的类型, 用一个单词表示, 例如上图中目标为一个小女孩,则object_type可以是“girl”,“person”等。其他类别包括“man”, "boy", "dog"等',
- 'description' => '图片中目标的类型, 用一个单词表示, 例如上图中目标为一个小女孩,则object_type可以是“girl”,“person”等。其他类别包括“man”, "boy", "dog"等',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'dog',
- ],
+ 'name' => ['title' => '模型训练任务名称', 'description' => '模型训练任务名称', 'type' => 'string', 'required' => true, 'example' => '熊猫图片生成'],
+ 'objectType' => ['title' => '图片中目标的类型, 用一个单词表示, 例如上图中目标为一个小女孩,则object_type可以是“girl”,“person”等。其他类别包括“man”, "boy", "dog"等', 'description' => '图片中目标的类型, 用一个单词表示, 例如上图中目标为一个小女孩,则object_type可以是“girl”,“person”等。其他类别包括“man”, "boy", "dog"等', 'type' => 'string', 'required' => true, 'example' => 'dog'],
'imageUrl' => [
'title' => '包含图片链接的列表, 可包含单张或多张图片的链接, 如["url_1", "url_2", ...]',
'description' => '包含图片链接的列表, 可包含单张或多张图片的链接, 如["url_1", "url_2", ...]',
'type' => 'array',
- 'items' => [
- 'description' => '图片地址,须确保能够有效访问,否则页面无法展示',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg',
- ],
+ 'items' => ['description' => '图片地址,须确保能够有效访问,否则页面无法展示', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'],
'required' => true,
],
- 'trainSteps' => [
- 'title' => '模型训练任务训练步骤',
- 'description' => '模型训练任务训练步骤',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '800',
- ],
+ 'trainSteps' => ['title' => '模型训练任务训练步骤', 'description' => '模型训练任务训练步骤', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '800'],
],
'required' => false,
],
@@ -9433,100 +10778,34 @@
'description' => '开放接口单对象响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型训练任务id',
- 'description' => '模型训练任务id',
- 'type' => 'string',
- 'example' => '456',
- ],
- 'modelId' => [
- 'title' => '模型id',
- 'description' => '模型id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
- 'name' => [
- 'title' => '模型训练任务名称',
- 'description' => '模型训练任务名称',
- 'type' => 'string',
- 'example' => '可爱熊猫模型训练任务',
- ],
- 'objectType' => [
- 'title' => '模型训练任务训练主体',
- 'description' => '模型训练任务训练主体',
- 'type' => 'string',
- 'example' => 'panda',
- ],
+ 'id' => ['title' => '模型训练任务id', 'description' => '模型训练任务id', 'type' => 'string', 'example' => '456'],
+ 'modelId' => ['title' => '模型id', 'description' => '模型id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
+ 'name' => ['title' => '模型训练任务名称', 'description' => '模型训练任务名称', 'type' => 'string', 'example' => '可爱熊猫模型训练任务'],
+ 'objectType' => ['title' => '模型训练任务训练主体', 'description' => '模型训练任务训练主体', 'type' => 'string', 'example' => 'panda'],
'imageUrl' => [
'title' => '模型训练任务图片地址列表',
'description' => '模型训练任务图片地址列表',
'type' => 'array',
- 'items' => [
- 'description' => '模型训练任务图片地址列表',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'."\n",
- ],
+ 'items' => ['description' => '模型训练任务图片地址列表', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'."\n"],
],
'jobStatus' => [
'title' => '模型训练任务状态',
'description' => '模型训练任务状态',
'type' => 'string',
'example' => 'TRAINING',
- 'enum' => [
- 'FINISHED',
- 'TRAINING',
- 'TRAINING_TERMINATED',
- 'WRONG_IMAGE_URL',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型训练任务进度',
- 'description' => '模型训练任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'TRAINING', 'TRAINING_TERMINATED', 'WRONG_IMAGE_URL', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型训练任务进度', 'description' => '模型训练任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'inferenceJobList' => [
'title' => '模型推理任务列表',
'description' => '模型推理任务列表',
@@ -9535,80 +10814,30 @@
'description' => '模型推理任务列表',
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'description' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'description' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'description' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
+ 'id' => ['title' => '模型推理任务id', 'description' => '模型推理任务id', 'type' => 'string', 'example' => '3220'],
+ 'promptId' => ['title' => 'promptId', 'description' => 'promptId', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'],
+ 'modelId' => ['title' => '模型Id', 'description' => '模型Id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
'jobStatus' => [
'title' => '模型推理任务状态',
'description' => '模型推理任务状态',
'type' => 'string',
'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'description' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型推理任务进度', 'description' => '模型推理任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'resultImageUrl' => [
'title' => '模型推理任务结果列表',
'description' => '模型推理任务结果列表',
'type' => 'array',
- 'items' => [
- 'description' => '模型推理任务结果列表',
- 'type' => 'string',
- 'example' => '0000.png',
- ],
+ 'items' => ['description' => '模型推理任务结果列表', 'type' => 'string', 'example' => '0000.png'],
'example' => '0000.png',
],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'description' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'createTime' => ['title' => '模型推理任务创建时间', 'description' => '模型推理任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
],
],
- 'inferenceImageCount' => [
- 'title' => '该模型总推理图片数量',
- 'description' => '该模型总推理图片数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'createTime' => [
- 'title' => '模型训练任务创建时间',
- 'description' => '模型训练任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'inferenceImageCount' => ['title' => '该模型总推理图片数量', 'description' => '该模型总推理图片数量', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'createTime' => ['title' => '模型训练任务创建时间', 'description' => '模型训练任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
'example' => '[]',
],
@@ -9619,58 +10848,55 @@
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"456\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"name\\": \\"可爱熊猫模型训练任务\\",\\n \\"objectType\\": \\"panda\\",\\n \\"imageUrl\\": [\\n \\"https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg\\\\n\\"\\n ],\\n \\"jobStatus\\": \\"TRAINING\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"inferenceJobList\\": [\\n {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"0000.png\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n ],\\n \\"inferenceImageCount\\": 5,\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
'title' => '个性化文生图/创建一个模型训练任务',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-05T08:54:22.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-10-12T09:35:03.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => '响应参数发生变更、错误码发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgAddModelTrainJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'Personalizedtxt2imgQueryImageAsset' => [
'summary' => '个性化文生图/图片二进制内容获取。',
'path' => '/api/v1/personalizedtxt2img/queryImageAsset',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'modelId',
'in' => 'query',
- 'schema' => [
- 'title' => '模型编号',
- 'description' => '模型编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'girl-xxxx-xxxx-xxxx-xxxx',
- ],
+ 'schema' => ['title' => '模型编号', 'description' => '模型编号', 'type' => 'string', 'required' => true, 'example' => 'girl-xxxx-xxxx-xxxx-xxxx'],
],
[
'name' => 'promptId',
'in' => 'query',
- 'schema' => [
- 'title' => '提示词编号',
- 'description' => '提示词编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'xxxx-xxxx-xxxx-xxxx',
- ],
+ 'schema' => ['title' => '提示词编号', 'description' => '提示词编号', 'type' => 'string', 'required' => true, 'example' => 'xxxx-xxxx-xxxx-xxxx'],
],
[
'name' => 'imageId',
'in' => 'query',
- 'schema' => [
- 'title' => '图片编号',
- 'description' => '图片编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => '0000.png',
- ],
+ 'schema' => ['title' => '图片编号', 'description' => '图片编号', 'type' => 'string', 'required' => true, 'example' => '0000.png'],
],
[
'name' => 'encodeFormat',
@@ -9681,60 +10907,153 @@
'type' => 'string',
'required' => false,
'example' => 'base64',
- 'enum' => [
- 'base64',
+ 'enum' => ['base64'],
+ ],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => ['title' => 'Object', 'description' => 'Object', 'type' => 'any', 'example' => 'BinaryData'],
+ ],
+ ],
+ 'errorCodes' => [
+ 400 => [
+ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''],
+ ],
+ 403 => [
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
+ ],
+ [
+ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''],
+ ],
+ 500 => [
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]',
+ 'title' => '个性化文生图/图片二进制内容获取',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryImageAsset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
],
+ ],
+ 'Personalizedtxt2imgQueryInferenceJobInfo' => [
+ 'summary' => '个性化文生图/查询模型推理任务的状态和结果信息。',
+ 'path' => '/api/v1/personalizedtxt2img/queryInferenceJobInfo',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'inferenceJobId',
+ 'in' => 'query',
+ 'schema' => ['title' => '推理任务编号', 'description' => '推理任务编号', 'type' => 'string', 'required' => true, 'example' => '180'],
+ ],
+ ],
'responses' => [
200 => [
'schema' => [
- 'title' => 'Object',
- 'description' => 'Object',
- 'type' => 'any',
- 'example' => 'BinaryData',
+ 'title' => 'OpenApiSingleResponse<InferenceJobInfoDTO>',
+ 'description' => '开放接口单对象响应体',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'id' => ['title' => '模型推理任务id', 'description' => '模型推理任务id', 'type' => 'string', 'example' => '3220'],
+ 'promptId' => ['title' => 'promptId', 'description' => 'promptId', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'],
+ 'modelId' => ['title' => '模型Id', 'description' => '模型Id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
+ 'jobStatus' => [
+ 'title' => '模型推理任务状态',
+ 'description' => '模型推理任务状态',
+ 'type' => 'string',
+ 'example' => 'FINISHED',
+ 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
+ ],
+ 'jobTrainProgress' => ['title' => '模型推理任务进度', 'description' => '模型推理任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
+ 'resultImageUrl' => [
+ 'title' => '模型推理任务结果列表',
+ 'description' => '模型推理任务结果列表',
+ 'type' => 'array',
+ 'items' => ['type' => 'string', 'description' => ''],
+ 'example' => '0000.png',
+ ],
+ 'createTime' => ['title' => '模型推理任务创建时间', 'description' => '模型推理任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
+ ],
+ 'example' => '[]',
+ ],
+ ],
+ 'example' => '{"success":true,"errCode":null,"errMessage":null,"requestId":"8be53f1f-ad1d-4548-b309-ab1140827833","data":{"id":"1","promptId":"prompt_id-xxxx-xxxx-xxxx-xxxx","modelId":"model_id-xxxx-xxxx-xxxx-xxxx","jobStatus":"NOT_START","resultImageUrl":null,"createUserId":"109988888888","createTime":"2024-06-28T11:02:32.441184"}}',
],
],
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '必要参数没有找到',
- ],
+ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
[
- [
- 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '资源没有找到',
- ],
+ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n}","type":"json"}]',
+ 'title' => '个性化文生图/查询模型推理任务的状态和结果信息',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => '响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryInferenceJobInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]',
- 'title' => '个性化文生图/图片二进制内容获取',
],
'Personalizedtxt2imgQueryModelTrainJobList' => [
'summary' => '个性化文生图/查询模型训练任务列表。',
'path' => '/api/v1/personalizedtxt2img/queryModelTrainJobList',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -9744,9 +11063,7 @@
'systemTags' => [
'operationType' => 'list',
'abilityTreeCode' => '226449',
- 'abilityTreeNodes' => [
- 'FEATUREaioral4PZ00K',
- ],
+ 'abilityTreeNodes' => ['FEATUREaioral4PZ00K'],
'tenantRelevance' => 'publicInformation',
],
'parameters' => [],
@@ -9757,37 +11074,11 @@
'description' => '开放接口多对象响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
@@ -9795,64 +11086,24 @@
'items' => [
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型训练任务id',
- 'description' => '模型训练任务id',
- 'type' => 'string',
- 'example' => '456',
- ],
- 'modelId' => [
- 'title' => '模型id',
- 'description' => '模型id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
- 'name' => [
- 'title' => '模型训练任务名称',
- 'description' => '模型训练任务名称',
- 'type' => 'string',
- 'example' => '可爱熊猫模型训练任务',
- ],
- 'objectType' => [
- 'title' => '模型训练任务训练主体',
- 'description' => '模型训练任务训练主体',
- 'type' => 'string',
- 'example' => 'panda',
- ],
+ 'id' => ['title' => '模型训练任务id', 'description' => '模型训练任务id', 'type' => 'string', 'example' => '456'],
+ 'modelId' => ['title' => '模型id', 'description' => '模型id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
+ 'name' => ['title' => '模型训练任务名称', 'description' => '模型训练任务名称', 'type' => 'string', 'example' => '可爱熊猫模型训练任务'],
+ 'objectType' => ['title' => '模型训练任务训练主体', 'description' => '模型训练任务训练主体', 'type' => 'string', 'example' => 'panda'],
'imageUrl' => [
'title' => '模型训练任务图片地址列表',
'description' => '模型训练任务图片地址列表',
'type' => 'array',
- 'items' => [
- 'description' => '模型训练任务图片地址列表',
- 'type' => 'string',
- 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'."\n",
- ],
+ 'items' => ['description' => '模型训练任务图片地址列表', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'."\n"],
],
'jobStatus' => [
'title' => '模型训练任务状态',
'description' => '模型训练任务状态',
'type' => 'string',
'example' => 'TRAINING',
- 'enum' => [
- 'FINISHED',
- 'TRAINING',
- 'TRAINING_TERMINATED',
- 'WRONG_IMAGE_URL',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型训练任务进度',
- 'description' => '模型训练任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'TRAINING', 'TRAINING_TERMINATED', 'WRONG_IMAGE_URL', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型训练任务进度', 'description' => '模型训练任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'inferenceJobList' => [
'title' => '模型推理任务列表',
'description' => '模型推理任务列表',
@@ -9860,81 +11111,33 @@
'items' => [
'type' => 'object',
'properties' => [
- 'id' => [
- 'title' => '模型推理任务id',
- 'description' => '模型推理任务id',
- 'type' => 'string',
- 'example' => '3220',
- ],
- 'promptId' => [
- 'title' => 'promptId',
- 'description' => 'promptId',
- 'type' => 'string',
- 'example' => 'promptId-xxxx-xxxx-xxxx',
- ],
- 'modelId' => [
- 'title' => '模型Id',
- 'description' => '模型Id',
- 'type' => 'string',
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
+ 'id' => ['title' => '模型推理任务id', 'description' => '模型推理任务id', 'type' => 'string', 'example' => '3220'],
+ 'promptId' => ['title' => 'promptId', 'description' => 'promptId', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'],
+ 'modelId' => ['title' => '模型Id', 'description' => '模型Id', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'],
'jobStatus' => [
'title' => '模型推理任务状态',
'description' => '模型推理任务状态',
'type' => 'string',
'example' => 'FINISHED',
- 'enum' => [
- 'FINISHED',
- 'INFERRING',
- 'INFERRING_TERMINATED',
- 'OOM',
- 'FINISHED',
- 'SUBMITTED',
- 'WAIT_SCHEDULE',
- 'TOO_MANY_INFERENCE_REQUESTS',
- ],
- ],
- 'jobTrainProgress' => [
- 'title' => '模型推理任务进度',
- 'description' => '模型推理任务进度',
- 'type' => 'number',
- 'format' => 'double',
- 'example' => '0.5',
+ 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'],
],
+ 'jobTrainProgress' => ['title' => '模型推理任务进度', 'description' => '模型推理任务进度', 'type' => 'number', 'format' => 'double', 'example' => '0.5'],
'resultImageUrl' => [
'title' => '模型推理任务结果列表',
'description' => '模型推理任务结果列表',
'type' => 'array',
- 'items' => [
- 'description' => '模型推理任务结果列表',
- 'type' => 'string',
- 'example' => '0000.png',
- ],
+ 'items' => ['description' => '模型推理任务结果列表', 'type' => 'string', 'example' => '0000.png'],
'example' => '0000.png',
],
- 'createTime' => [
- 'title' => '模型推理任务创建时间',
- 'description' => '模型推理任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'createTime' => ['title' => '模型推理任务创建时间', 'description' => '模型推理任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
+ 'description' => '',
],
],
- 'inferenceImageCount' => [
- 'title' => '该模型总推理图片数量',
- 'description' => '该模型总推理图片数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '5',
- ],
- 'createTime' => [
- 'title' => '模型训练任务创建时间',
- 'description' => '模型训练任务创建时间',
- 'type' => 'string',
- 'example' => '2023-12-25T12:00:00',
- ],
+ 'inferenceImageCount' => ['title' => '该模型总推理图片数量', 'description' => '该模型总推理图片数量', 'type' => 'integer', 'format' => 'int32', 'example' => '5'],
+ 'createTime' => ['title' => '模型训练任务创建时间', 'description' => '模型训练任务创建时间', 'type' => 'string', 'example' => '2023-12-25T12:00:00'],
],
+ 'description' => '',
],
'example' => '[]',
],
@@ -9945,36 +11148,44 @@
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"id\\": \\"456\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"name\\": \\"可爱熊猫模型训练任务\\",\\n \\"objectType\\": \\"panda\\",\\n \\"imageUrl\\": [\\n \\"https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg\\\\n\\"\\n ],\\n \\"jobStatus\\": \\"TRAINING\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"inferenceJobList\\": [\\n {\\n \\"id\\": \\"3220\\",\\n \\"promptId\\": \\"promptId-xxxx-xxxx-xxxx\\",\\n \\"modelId\\": \\"modelId-xxxx-xxxx-xxxx\\",\\n \\"jobStatus\\": \\"FINISHED\\",\\n \\"jobTrainProgress\\": 0.5,\\n \\"resultImageUrl\\": [\\n \\"0000.png\\"\\n ],\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n ],\\n \\"inferenceImageCount\\": 5,\\n \\"createTime\\": \\"2023-12-25T12:00:00\\"\\n }\\n ]\\n}","type":"json"}]',
'title' => '个性化文生图/查询模型训练任务列表',
+ 'changeSet' => [
+ ['createdAt' => '2025-03-05T08:54:21.000Z', 'description' => '错误码发生变更'],
+ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainJobList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
],
'Personalizedtxt2imgQueryModelTrainStatus' => [
'summary' => '个性化文生图/模型训练状态查询。',
'path' => '/api/v1/personalizedtxt2img/queryModelTrainStatus',
- 'methods' => [
- 'get',
- ],
- 'schemes' => [
- 'https',
- ],
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'get',
- ],
+ 'systemTags' => ['operationType' => 'get'],
'parameters' => [
[
'name' => 'modelId',
'in' => 'query',
- 'schema' => [
- 'title' => '模型Id',
- 'description' => '模型编号',
- 'type' => 'string',
- 'required' => true,
- 'example' => 'modelId-xxxx-xxxx-xxxx',
- ],
+ 'schema' => ['title' => '模型Id', 'description' => '模型编号', 'type' => 'string', 'required' => true, 'example' => 'modelId-xxxx-xxxx-xxxx'],
],
],
'responses' => [
@@ -9984,48 +11195,17 @@
'description' => '开放接口单对象响应体',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'object',
'properties' => [
- 'modelTrainStatus' => [
- 'title' => '模型训练状态',
- 'description' => '模型训练状态',
- 'type' => 'string',
- 'example' => 'FINISHED',
- ],
+ 'modelTrainStatus' => ['title' => '模型训练状态', 'description' => '模型训练状态', 'type' => 'string', 'example' => 'FINISHED'],
],
'example' => '[]',
],
@@ -10035,371 +11215,447 @@
],
'errorCodes' => [
400 => [
- [
- 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION',
- 'errorMessage' => '必要参数没有找到',
- ],
+ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''],
],
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
[
- [
- 'errorCode' => 'B_MODEL_TRAIN_JOB_NOT_EXIST',
- 'errorMessage' => '模型训练任务不存在',
- ],
+ ['errorCode' => 'B_MODEL_TRAIN_JOB_NOT_EXIST', 'errorMessage' => '模型训练任务不存在', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"modelTrainStatus\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]',
'title' => '个性化文生图/模型训练状态查询',
- ],
- 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList' => [
- 'summary' => '阿里云控制台/列出阿里云控制台上可使用的服务列表。',
- 'path' => '/api/v1/aliyunconsole/queryAliyunConsoleServcieList',
- 'methods' => [
- 'get',
+ 'changeSet' => [
+ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => '错误码发生变更、响应参数发生变更'],
],
- 'schemes' => [
- 'https',
+ 'flowControl' => [
+ 'flowControlList' => [],
],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'QueryApplicationAccessId' => [
+ 'summary' => '阿里云控制台/获取应用访问识别码(appkey)信息。',
+ 'path' => '/api/v1/aliyunConsole/queryApplicationAccessId',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
'deprecated' => false,
- 'systemTags' => [
- 'operationType' => 'list',
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'applicationAccessId',
+ 'in' => 'query',
+ 'schema' => ['title' => '应用识别码、appkey', 'description' => '应用访问识别码(appkey)', 'type' => 'string', 'required' => false, 'example' => '1234567890'],
+ ],
],
- 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
- 'description' => '开放接口多数据结构体返回对象',
+ 'title' => 'SingleResponse<ApplicationAccessIdDTO>',
+ 'description' => 'SingleResponse<ApplicationAccessIdDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
+ 'data' => [
+ 'title' => '数据对象',
+ 'description' => '数据对象',
+ 'type' => 'object',
+ 'properties' => [
+ 'applicationAccessId' => ['title' => '应用识别码、appkey', 'description' => '应用识别码、appkey', 'type' => 'string', 'example' => '1234567890'],
+ 'applicationAccessSecret' => ['title' => '应用秘钥,只有控制台请求才会返回', 'description' => '应用秘钥,只有控制台请求才会返回', 'type' => 'string', 'example' => 'MyAppSecret'],
+ ],
+ 'example' => '[]',
],
+ ],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
+ ],
+ ],
+ ],
+ 'errorCodes' => [
+ 500 => [
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
+ ],
+ ],
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询应用访问编号',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryApplicationAccessId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ ],
+ ],
+ 'QueryProject' => [
+ 'summary' => '阿里云控制台/获取项目列表',
+ 'path' => '/api/v1/aliyunConsole/queryProject',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
+ 'security' => [
+ [
+ 'AK' => [],
+ ],
+ ],
+ 'deprecated' => false,
+ 'systemTags' => ['operationType' => 'get'],
+ 'parameters' => [
+ [
+ 'name' => 'projectId',
+ 'in' => 'query',
+ 'schema' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'required' => false, 'example' => '123'],
+ ],
+ ],
+ 'responses' => [
+ 200 => [
+ 'schema' => [
+ 'title' => 'SingleResponse<ProjectDTO>',
+ 'description' => 'SingleResponse<ProjectDTO>',
+ 'type' => 'object',
+ 'properties' => [
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
- 'type' => 'array',
- 'items' => [
- 'type' => 'object',
- 'properties' => [
- 'ServiceCode' => [
- 'title' => '服务编码',
- 'description' => '服务编码',
- 'type' => 'string',
- 'example' => 'online_ai_algorithm_personalized_text_to_image_call_count',
- ],
- 'ServiceName' => [
- 'title' => '服务名称',
- 'description' => '服务名称',
- 'type' => 'string',
- 'example' => 'AI算法模型-个性化文生图-在线按量调用',
- ],
- 'FreeCount' => [
- 'title' => '体验调用量',
- 'description' => '体验调用量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => ['title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'example' => '67055'],
+ 'ProjectName' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'MyProject'],
+ 'ProjectType' => ['title' => '项目类型', 'description' => '项目类型', 'type' => 'string', 'example' => 'WebApplication'],
+ 'ProjectApps' => [
+ 'title' => '项目应用列表',
+ 'description' => '项目应用列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '项目应用',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'example' => '2144'],
+ 'ApplicationAccessIds' => [
+ 'title' => '应用访问凭证',
+ 'description' => '应用访问凭证',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'applicationAccessId' => ['title' => '应用识别码、appkey', 'description' => '应用识别码、appkey', 'type' => 'string', 'example' => '1234567890'],
+ 'applicationAccessSecret' => ['title' => '应用秘钥,只有控制台请求才会返回', 'description' => '应用秘钥,只有控制台请求才会返回', 'type' => 'string', 'example' => 'MyAppSecret'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ProjectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '159'],
+ ],
],
- 'FreeConcurrencyCount' => [
- 'title' => '体验并发数',
- 'description' => '体验并发数',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
+ ],
+ 'ProjectSDK' => [
+ 'title' => '项目SDK',
+ 'description' => '项目SDK',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SdkName' => ['title' => 'SDK名称', 'description' => 'SDK名称', 'type' => 'string', 'example' => 'JSSDK'],
+ 'DeployMode' => ['title' => '部署模式:客户端或者服务端', 'description' => '部署模式:客户端或者服务端', 'type' => 'string', 'example' => '服务端'],
+ 'DevelopLanguage' => ['title' => '开发语言', 'description' => '开发语言', 'type' => 'string', 'example' => 'JAVA'],
+ 'SdkUrl' => ['title' => 'SDK地址', 'description' => 'SDK地址', 'type' => 'string', 'example' => 'http://demo.com/sdk.zip'],
+ 'DocUrl' => ['title' => '文档地址', 'description' => '文档地址', 'type' => 'string', 'example' => 'http://demo.com/doc'],
+ 'DemoUrl' => ['title' => 'demo地址', 'description' => 'demo地址', 'type' => 'string', 'example' => 'http://demo.com/demo'],
+ 'SdkVersion' => ['title' => 'SDK版本', 'description' => 'SDK版本', 'type' => 'string', 'example' => '5.1.0'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-01T13:40:53Z'],
+ ],
+ 'description' => '',
],
],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-01T13:40:53Z'],
],
'example' => '[]',
],
],
'example' => '{'."\n"
- .' "data":['."\n"
- .' {'."\n"
- .' "freeConcurrencyCount":1,'."\n"
- .' "serviceCode":"online_oral_evaluation_call_count",'."\n"
- .' "serviceName":"口语评测-在线预付费按量调用",'."\n"
- .' "freeCount":500'."\n"
- .' },'."\n"
- .' {'."\n"
- .' "freeConcurrencyCount":1,'."\n"
- .' "serviceCode":"online_ai_algorithm_conversation_call_count",'."\n"
- .' "serviceName":"AI算法模型-人机对话-在线按量调用",'."\n"
- .' "freeCount":500'."\n"
- .' }'."\n"
- .' ],'."\n"
- .' "success":true,'."\n"
- .' "requestId":"592A27EF-26D3-1434-98C1-97AD63337852",'."\n"
- .' "notEmpty":true,'."\n"
- .' "empty":false'."\n"
+ .' "success": true,'."\n"
+ .' “data":{'."\n"
+ .' "appId": "a123",'."\n"
+ .' "deviceType": "iOS",'."\n"
+ .' "deployType": "server",'."\n"
+ .' "devLanguage": "java",'."\n"
+ .' "sdkVersion": "1.0.0",'."\n"
+ .' "sdkUrl": "http://www.xxx.com/abc.tgz",'."\n"
+ .' "sdkMd5": "1234567890",'."\n"
+ .' "sdkName": "XXAppIdServerSDK2024"'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
.'}',
],
],
],
'errorCodes' => [
403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
- ],
+ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''],
],
500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
- ],
+ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"ServiceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"ServiceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"FreeCount\\": 100,\\n \\"FreeConcurrencyCount\\": 10\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '开放的服务能力列表',
- ],
- 'CountOralEvaluationStatisticsConcurrent' => [
- 'summary' => '智能批改/口语评测/统计/并发数',
- 'path' => '/api/v1/aliyunConsole/countOralEvaluationStatisticsConcurrent',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ProjectId\\": \\"67055\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"2144\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"159\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"JSSDK\\",\\n \\"DeployMode\\": \\"服务端\\",\\n \\"DevelopLanguage\\": \\"JAVA\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\"5.1.0\\",\\n \\"CreateTime\\": \\"2024-11-01T13:40:53Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-11-01T13:40:53Z\\"\\n }\\n}","type":"json"}]',
+ 'title' => '查询项目信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'QueryProjectList' => [
+ 'summary' => '阿里云控制台/获取项目列表',
+ 'path' => '/api/v1/aliyunConsole/queryProjectList',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '260347',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
- ],
+ 'abilityTreeCode' => '259876',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体对象。',
- 'required' => false,
- '$ref' => '#/components/schemas/OralEvaluationStatisticsConcurrentCountRequest',
- ],
- ],
- ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiMultiResponse<OralEvaluationStatisticsConcurrentCountResponseDTO>',
- 'description' => 'OpenApiMultiResponse<OralEvaluationStatisticsConcurrentCountResponseDTO>',
+ 'title' => 'OpenApiMultiResponse<ProjectDTO>',
+ 'description' => 'OpenApiMultiResponse<ProjectDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'array',
'items' => [
- 'description' => '返回数据对象',
- '$ref' => '#/components/schemas/OralEvaluationStatisticsConcurrentCountResponse',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => ['title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'example' => '4910'],
+ 'ProjectName' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'MyProject'],
+ 'ProjectType' => ['title' => '项目类型', 'description' => '项目类型', 'type' => 'string', 'example' => 'WebApplication'],
+ 'ProjectApps' => [
+ 'title' => '项目应用列表',
+ 'description' => '项目应用列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '应用结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'example' => '4700'],
+ 'ApplicationAccessIds' => [
+ 'title' => '应用访问凭证',
+ 'description' => '应用访问凭证',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'applicationAccessId' => ['title' => '应用识别码、appkey', 'description' => '应用识别码、appkey', 'type' => 'string', 'example' => '1234567890'],
+ 'applicationAccessSecret' => ['title' => '应用秘钥,只有控制台请求才会返回', 'description' => '应用秘钥,只有控制台请求才会返回', 'type' => 'string', 'example' => 'MyAppSecret'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ProjectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '4747'],
+ ],
+ ],
+ ],
+ 'ProjectSDK' => [
+ 'title' => '项目SDK',
+ 'description' => '项目SDK',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SdkName' => ['title' => 'SDK名称', 'description' => 'SDK名称', 'type' => 'string', 'example' => 'GO AUTH'],
+ 'DeployMode' => ['title' => '部署模式:客户端或者服务端', 'description' => '部署模式:客户端或者服务端', 'type' => 'string', 'example' => '服务端'],
+ 'DevelopLanguage' => ['title' => '开发语言', 'description' => '开发语言', 'type' => 'string', 'example' => 'JAVA'],
+ 'SdkUrl' => ['title' => 'SDK地址', 'description' => 'SDK地址', 'type' => 'string', 'example' => 'http://demo.com/sdk.zip'],
+ 'DocUrl' => ['title' => '文档地址', 'description' => '文档地址', 'type' => 'string', 'example' => 'http://demo.com/doc'],
+ 'DemoUrl' => ['title' => 'demo地址', 'description' => 'demo地址', 'type' => 'string', 'example' => 'http://demo.com/demo'],
+ 'SdkVersion' => ['title' => 'SDK版本', 'description' => 'SDK版本', 'type' => 'string', 'example' => '.3.52'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-07-16T08:23:19Z'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2025-02-18 12:10:22'],
+ ],
+ 'description' => '',
],
'example' => '[]',
],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' “data":[{'."\n"
+ .' "appId": "a123",'."\n"
+ .' "deviceType": "iOS",'."\n"
+ .' "deployType": "server",'."\n"
+ .' "devLanguage": "java",'."\n"
+ .' "sdkVersion": "1.0.0",'."\n"
+ .' "sdkUrl": "http://www.xxx.com/abc.tgz",'."\n"
+ .' "sdkMd5": "1234567890",'."\n"
+ .' "sdkName": "XXAppIdServerSDK2024"'."\n"
+ .' }],'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"\\",\\n \\"projectData\\": {\\n \\"applicationInternalId\\": \\"\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"count\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '口语评测服务并发数统计',
- ],
- 'CountOralEvaluationStatisticsCalls' => [
- 'summary' => '智能批改/口语评测/统计/调用量',
- 'path' => '/api/v1/aliyunConsole/countOralEvaluationStatisticsCalls',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"ProjectId\\": \\"4910\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"4700\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"4747\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"GO AUTH\\",\\n \\"DeployMode\\": \\"服务端\\",\\n \\"DevelopLanguage\\": \\"JAVA\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\".3.52\\",\\n \\"CreateTime\\": \\"2024-07-16T08:23:19Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2025-02-18 12:10:22\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询项目列表',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryProjectList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'QueryPurchasedService' => [
+ 'summary' => '阿里云控制台/已经购买过的服务项目',
+ 'path' => '/api/v1/aliyunConsole/queryPurchasedService',
+ 'methods' => ['get'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
],
],
- 'consumes' => [
- 'application/json',
- ],
- 'produces' => [
- 'application/json',
- ],
- 'operationType' => 'read',
'deprecated' => false,
'systemTags' => [
'operationType' => 'list',
- 'abilityTreeCode' => '260346',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
- ],
+ 'abilityTreeCode' => '264513',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
'tenantRelevance' => 'publicInformation',
],
- 'parameters' => [
- [
- 'name' => 'body',
- 'in' => 'body',
- 'style' => 'json',
- 'schema' => [
- 'description' => '请求体参数',
- 'required' => false,
- '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountRequest',
- ],
- ],
- ],
+ 'parameters' => [],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiMultiResponse<OralEvaluationStatisticsCallsCountResponseDTO>',
- 'description' => 'OpenApiMultiResponse<OralEvaluationStatisticsCallsCountResponseDTO>',
+ 'title' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
+ 'description' => 'OpenApiMultiResponse<AliyunConsoleServiceInfoDTO>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
'type' => 'array',
- 'items' => [
- 'description' => '返回数据对象',
- '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountResponse',
- ],
+ 'items' => ['description' => '服务信息结构体', '$ref' => '#/components/schemas/AliyunConsoleServiceInfoDTO'],
'example' => '[]',
],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"\\",\\n \\"projectData\\": {\\n \\"applicationInternalId\\": \\"\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"count\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '口语评测服务调用量查询',
- ],
- 'CountOralEvaluationStatisticsError' => [
- 'summary' => '智能批改/口语评测/统计/调用错误',
- 'path' => '/api/v1/aliyunConsole/countOralEvaluationStatisticsError',
- 'methods' => [
- 'post',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"serviceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"serviceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"freeCount\\": 100,\\n \\"freeConcurrencyCount\\": 10,\\n \\"documentUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\",\\n \\"buyUrl\\": \\"https://www.aliyun.com/product/ai-algorithm\\"\\n }\\n ]\\n}","type":"json"}]',
+ 'title' => '查询已购买的服务',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
],
- 'schemes' => [
- 'https',
+ 'ramActions' => [
+ [
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryPurchasedService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
],
+ ],
+ 'UpdateProject' => [
+ 'summary' => '阿里云控制台/更新项目信息',
+ 'path' => '/api/v1/aliyunConsole/updateProject',
+ 'methods' => ['post'],
+ 'schemes' => ['https'],
'security' => [
[
'AK' => [],
@@ -10407,7 +11663,10 @@
],
'deprecated' => false,
'systemTags' => [
- 'operationType' => 'list',
+ 'operationType' => 'update',
+ 'abilityTreeCode' => '259771',
+ 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'],
+ 'tenantRelevance' => 'publicInformation',
],
'parameters' => [
[
@@ -10415,338 +11674,1396 @@
'in' => 'body',
'style' => 'json',
'schema' => [
- 'description' => '口语评测服务错误码统计请求体对象',
+ 'title' => 'ProjectUpdateCmd',
+ 'description' => 'ProjectUpdateCmd',
+ 'type' => 'object',
+ 'properties' => [
+ 'projectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'required' => false, 'example' => '123'],
+ 'projectName' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'required' => false, 'example' => 'MyProject'],
+ ],
'required' => false,
- '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountRequest',
],
],
],
'responses' => [
200 => [
'schema' => [
- 'title' => 'OpenApiMultiResponse<OralEvaluationStatisticsErrorCountResponseDTO>',
- 'description' => 'OpenApiMultiResponse<OralEvaluationStatisticsErrorCountResponseDTO>',
+ 'title' => 'SingleResponse<Boolean>',
+ 'description' => 'SingleResponse<Boolean>',
'type' => 'object',
'properties' => [
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
+ 'requestId' => ['title' => '请求编号', 'description' => '请求编号', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'],
+ 'success' => ['title' => '是否成功', 'description' => '是否成功', 'type' => 'boolean', 'example' => 'true'],
+ 'errCode' => ['title' => '错误信息编码', 'description' => '错误信息编码', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'],
+ 'errMessage' => ['title' => '错误信息', 'description' => '错误信息', 'type' => 'string', 'example' => '未知错误'],
+ 'httpStatusCode' => ['title' => 'http状态码', 'description' => 'http状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200'],
'data' => [
'title' => '数据对象',
'description' => '数据对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '口语评测服务错误码响应体对象',
- '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountResponse',
+ 'type' => 'object',
+ 'properties' => [
+ 'ProjectId' => ['title' => '项目ID', 'description' => '项目ID', 'type' => 'string', 'example' => '56160'],
+ 'ProjectName' => ['title' => '项目名称', 'description' => '项目名称', 'type' => 'string', 'example' => 'MyProject'],
+ 'ProjectType' => ['title' => '项目类型', 'description' => '项目类型', 'type' => 'string', 'example' => 'WebApplication'],
+ 'ProjectApps' => [
+ 'title' => '项目应用列表',
+ 'description' => '项目应用列表',
+ 'type' => 'array',
+ 'items' => [
+ 'description' => '应用结构体',
+ 'type' => 'object',
+ 'properties' => [
+ 'Id' => ['title' => '应用内部id', 'description' => '应用内部id', 'type' => 'string', 'example' => '4498'],
+ 'ApplicationAccessIds' => [
+ 'title' => '应用访问凭证',
+ 'description' => '应用访问凭证',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'applicationAccessId' => ['title' => '应用识别码、appkey', 'description' => '应用识别码、appkey', 'type' => 'string', 'example' => '1234567890'],
+ 'applicationAccessSecret' => ['title' => '应用秘钥,只有控制台请求才会返回', 'description' => '应用秘钥,只有控制台请求才会返回', 'type' => 'string', 'example' => 'MyAppSecret'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'ProjectId' => ['title' => '项目id', 'description' => '项目id', 'type' => 'string', 'example' => '1889'],
+ ],
+ ],
+ ],
+ 'ProjectSDK' => [
+ 'title' => '项目SDK',
+ 'description' => '项目SDK',
+ 'type' => 'array',
+ 'items' => [
+ 'type' => 'object',
+ 'properties' => [
+ 'SdkName' => ['title' => 'SDK名称', 'description' => 'SDK名称', 'type' => 'string', 'example' => 'PHP服务端SDK'],
+ 'DeployMode' => ['title' => '部署模式:客户端或者服务端', 'description' => '部署模式:客户端或者服务端', 'type' => 'string', 'example' => '服务端'],
+ 'DevelopLanguage' => ['title' => '开发语言', 'description' => '开发语言', 'type' => 'string', 'example' => 'PHP'],
+ 'SdkUrl' => ['title' => 'SDK地址', 'description' => 'SDK地址', 'type' => 'string', 'example' => 'http://demo.com/sdk.zip'],
+ 'DocUrl' => ['title' => '文档地址', 'description' => '文档地址', 'type' => 'string', 'example' => 'http://demo.com/doc'],
+ 'DemoUrl' => ['title' => 'demo地址', 'description' => 'demo地址', 'type' => 'string', 'example' => 'http://demo.com/demo'],
+ 'SdkVersion' => ['title' => 'SDK版本', 'description' => 'SDK版本', 'type' => 'string', 'example' => '4.13.0'],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-11-01T13:40:53Z'],
+ ],
+ 'description' => '',
+ ],
+ ],
+ 'CreateTime' => ['title' => '创建时间', 'description' => '创建时间', 'type' => 'string', 'example' => '2024-12-10T02:07:16Z'],
],
'example' => '[]',
],
],
+ 'example' => '{'."\n"
+ .' "success": true,'."\n"
+ .' "data":{'."\n"
+ .' "projectId": "proj_123456",'."\n"
+ .' "projectAppIds": ["app_001", "app_002"],'."\n"
+ .' "createTime": "2023-10-01T10:00:00Z",'."\n"
+ .' "updateTime": "2023-10-02T11:00:00Z"'."\n"
+ .' },'."\n"
+ .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n"
+ .'}',
],
],
],
- 'errorCodes' => [
- 403 => [
- [
- 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION',
- 'errorMessage' => '鉴权失败或权限不足',
+ 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"ProjectId\\": \\"56160\\",\\n \\"ProjectName\\": \\"MyProject\\",\\n \\"ProjectType\\": \\"WebApplication\\",\\n \\"ProjectApps\\": [\\n {\\n \\"Id\\": \\"4498\\",\\n \\"ApplicationAccessIds\\": [\\n {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n ],\\n \\"ProjectId\\": \\"1889\\"\\n }\\n ],\\n \\"ProjectSDK\\": [\\n {\\n \\"SdkName\\": \\"PHP服务端SDK\\",\\n \\"DeployMode\\": \\"服务端\\",\\n \\"DevelopLanguage\\": \\"PHP\\",\\n \\"SdkUrl\\": \\"http://demo.com/sdk.zip\\",\\n \\"DocUrl\\": \\"http://demo.com/doc\\",\\n \\"DemoUrl\\": \\"http://demo.com/demo\\",\\n \\"SdkVersion\\": \\"4.13.0\\",\\n \\"CreateTime\\": \\"2024-11-01T13:40:53Z\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2024-12-10T02:07:16Z\\"\\n }\\n}","type":"json"}]',
+ 'title' => '更新项目信息',
+ 'changeSet' => [],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ramActions' => [
+ [
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:UpdateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 500 => [
- [
- 'errorCode' => 'UNKNOWN_ERROR',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ ],
+ ],
+ ],
+ 'endpoints' => [
+ ['regionId' => 'cn-beijing', 'regionName' => '华北2(北京)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aicontent.cn-beijing.aliyuncs.com', 'endpoint' => 'aicontent.cn-beijing.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-hangzhou', 'regionName' => '华东1(杭州)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aicontent.cn-hangzhou.aliyuncs.com', 'endpoint' => 'aicontent.cn-hangzhou.aliyuncs.com', 'vpc' => ''],
+ ['regionId' => 'cn-shanghai', 'regionName' => '华东2(上海)', 'areaId' => 'asiaPacific', 'areaName' => '亚太', 'public' => 'aicontent.aliyuncs.com', 'endpoint' => 'aicontent.aliyuncs.com', 'vpc' => 'aicontent-vpc.cn-shanghai.aliyuncs.com'],
+ ['regionId' => 'public', 'regionName' => '公网', 'areaId' => 'other', 'areaName' => '其它', 'public' => 'aicontent.aliyuncs.com', 'endpoint' => 'aicontent.aliyuncs.com', 'vpc' => ''],
+ ],
+ 'errorCodes' => [
+ ['code' => 'B.Permission.OrgNoExistException', 'message' => 'B.Permission .OrgNoExistException.', 'http_code' => 403, 'description' => '鉴权失败-组织不存在'],
+ ],
+ 'changeSet' => [
+ [
+ 'apis' => [
+ ['description' => '请求参数发生变更', 'api' => 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun'],
+ ['description' => '请求参数发生变更', 'api' => 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun'],
+ ['description' => '请求参数发生变更', 'api' => 'ExecuteAITeacherEnglishParaphraseChatMessage'],
+ ],
+ 'createdAt' => '2025-04-23T03:18:49.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'Personalizedtxt2imgAddInferenceJob'],
+ ['description' => '错误码发生变更', 'api' => 'Personalizedtxt2imgAddModelTrainJob'],
+ ['description' => '错误码发生变更', 'api' => 'Personalizedtxt2imgQueryModelTrainJobList'],
+ ],
+ 'createdAt' => '2025-03-05T08:54:28.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '响应参数发生变更', 'api' => 'GetAITeacherSyncDialogueSuggestion'],
+ ],
+ 'createdAt' => '2024-12-30T02:53:41.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更', 'api' => 'Personalizedtxt2imgAddModelTrainJob'],
+ ],
+ 'createdAt' => '2024-10-12T09:35:10.000Z',
+ 'description' => '',
+ ],
+ [
+ 'apis' => [
+ ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList'],
+ ['description' => '响应参数发生变更', 'api' => 'Personalizedtxt2imgAddInferenceJob'],
+ ['description' => '响应参数发生变更、错误码发生变更', 'api' => 'Personalizedtxt2imgAddModelTrainJob'],
+ ['description' => '响应参数发生变更', 'api' => 'Personalizedtxt2imgQueryInferenceJobInfo'],
+ ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'Personalizedtxt2imgQueryModelTrainJobList'],
+ ['description' => '错误码发生变更、响应参数发生变更', 'api' => 'Personalizedtxt2imgQueryModelTrainStatus'],
+ ],
+ 'createdAt' => '2024-07-31T04:03:12.000Z',
+ 'description' => '',
+ ],
+ ],
+ 'flowControl' => [
+ 'flowControlList' => [],
+ ],
+ 'ram' => [
+ 'productCode' => 'AiContent',
+ 'productName' => '智能科教内容生成平台',
+ 'ramCodes' => ['aicontent'],
+ 'ramLevel' => '操作级',
+ 'ramConditions' => [],
+ 'ramActions' => [
+ [
+ 'apiName' => 'ModelRouterQueryUsageBreakdown',
+ 'description' => '用量批量明细查询',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryUsageBreakdown',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"\\",\\n \\"ProjectData\\": {\\n \\"applicationInternalId\\": \\"\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"ErrorCode\\": \\"\\",\\n \\"ErrorMessage\\": \\"\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"\\",\\n \\"count\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '口语评测服务错误码统计',
- ],
- 'AliyunConsoleOpenApiQueryPaidResource' => [
- 'summary' => '阿里云控制台/列出购买过的资源列表',
- 'path' => '/api/v1/aliyunConsole/queryPaidResource',
- 'methods' => [
- 'get',
+ [
+ 'apiName' => 'ExecuteTextbookAssistantStartConversation',
+ 'description' => '开启与AI老师的对话',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantStartConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'schemes' => [
- 'https',
+ [
+ 'apiName' => 'PersonalizedTextToImageQueryPreModelInferenceJobInfo',
+ 'description' => '查询预置模型推理任务信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:PersonalizedTextToImageQueryPreModelInferenceJobInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'security' => [
- [
- 'AK' => [],
+ [
+ 'apiName' => 'ModelRouterCreateApiKey',
+ 'description' => '创建api密钥',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
],
- 'consumes' => [
- 'application/json',
+ [
+ 'apiName' => 'ModelRouterQueryCostOverviewMetrics',
+ 'description' => '获取用量概览指标',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostOverviewMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'produces' => [
- 'application/json',
+ [
+ 'apiName' => 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList',
+ 'description' => '服务列表查询',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServiceList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
],
- 'operationType' => 'read',
- 'deprecated' => false,
- 'systemTags' => [
+ [
+ 'apiName' => 'AITeacherExpansionPracticeTaskGenerate',
+ 'description' => '拓展练对话任务生成',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExpansionPracticeTaskGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryProject',
+ 'description' => '查询项目信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryBillingRuleList',
+ 'description' => '计费管理/查询计费规则列表',
'operationType' => 'list',
- 'riskType' => 'none',
- 'chargeType' => 'free',
- 'abilityTreeNodes' => [
- 'FEATUREaioralV0UKKO',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryBillingRuleList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
],
- 'tenantRelevance' => 'tenant',
],
- 'parameters' => [
- [
- 'name' => 'nextToken',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'nextToken',
- 'description' => 'nextToken',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'xxxx-xxx-xxxxx',
+ [
+ 'apiName' => 'Personalizedtxt2imgAddInferenceJob',
+ 'description' => '个性化文生图/基于一个模型创建图片推理任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgAddInferenceJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'maxResults',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'maxResults',
- 'description' => 'maxResults',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherExpansionDialogue',
+ 'description' => '执行拓展练',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:AITeacherExecuteExpansionPractice',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'resourceType',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'resourceType',
- 'description' => 'resourceType',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'ALL',
+ ],
+ [
+ 'apiName' => 'CreateAccessWarrant',
+ 'description' => '创建授权信息',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:CreateAccessWarrant',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'pageSize',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'pageSize',
- 'description' => 'pageSize',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '10',
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryClientDiscountLogs',
+ 'description' => '客户管理/获取部门折扣修改历史',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryClientDiscountLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'pageIndex',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'pageIndex',
- 'description' => 'pageIndex',
- 'type' => 'integer',
- 'format' => 'int32',
- 'required' => false,
- 'example' => '1',
+ ],
+ [
+ 'apiName' => 'ModelRouterUpdateClient',
+ 'description' => '更新客户信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateClient',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'orderBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'orderBy',
- 'description' => 'orderBy',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'resourceId',
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun',
+ 'description' => '英语作文生成',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherEnglishCompositionTutoringWorkflowRun',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'orderDirection',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'orderDirection',
- 'description' => 'orderDirection',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'DESC',
+ ],
+ [
+ 'apiName' => 'ModelRouterGetClientBalance',
+ 'description' => '客户管理/获取部门余额',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterGetClientBalance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'groupBy',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'groupBy',
- 'description' => 'groupBy',
- 'type' => 'string',
- 'required' => false,
- 'example' => 'resourceId',
+ ],
+ [
+ 'apiName' => 'ModelRouterUpdateConversation',
+ 'description' => '更新会话信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
- [
- 'name' => 'needTotalCount',
- 'in' => 'query',
- 'schema' => [
- 'title' => 'needTotalCount',
- 'description' => 'needTotalCount',
- 'type' => 'boolean',
- 'required' => false,
- 'example' => 'true',
+ ],
+ [
+ 'apiName' => 'ListTextbookAssistantBookDirectories',
+ 'description' => '获取英语教材的书本目录',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantBookDirectories',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responses' => [
- 200 => [
- 'schema' => [
- 'title' => 'OpenApiPageResponse<PaidResourceDTO>',
- 'description' => 'OpenApiPageResponse<PaidResourceDTO>',
- 'type' => 'object',
- 'properties' => [
- 'totalCount' => [
- 'title' => '总数量',
- 'description' => '总数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '100',
- ],
- 'pageSize' => [
- 'title' => '每页数量',
- 'description' => '每页数量',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'pageIndex' => [
- 'title' => '页码',
- 'description' => '页码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '1',
- ],
- 'requestId' => [
- 'title' => '请求编号',
- 'description' => '请求编号',
- 'type' => 'string',
- 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx',
- ],
- 'success' => [
- 'title' => '是否成功',
- 'description' => '是否成功',
- 'type' => 'boolean',
- 'example' => 'true',
- ],
- 'errCode' => [
- 'title' => '错误信息编码',
- 'description' => '错误信息编码',
- 'type' => 'string',
- 'example' => 'UNKNOWN_ERROR',
- ],
- 'errMessage' => [
- 'title' => '错误信息',
- 'description' => '错误信息',
- 'type' => 'string',
- 'example' => '未知错误',
- ],
- 'httpStatusCode' => [
- 'title' => 'http状态码',
- 'description' => 'http状态码',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '200',
- ],
- 'nextToken' => [
- 'title' => 'nextToken',
- 'description' => 'nextToken',
- 'type' => 'string',
- 'example' => 'xxxx-xxx-xxxxx',
- ],
- 'skip' => [
- 'title' => 'skip',
- 'description' => 'skip',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'maxResults' => [
- 'title' => 'maxResults',
- 'description' => 'maxResults',
- 'type' => 'integer',
- 'format' => 'int32',
- 'example' => '10',
- ],
- 'data' => [
- 'title' => '数据对象',
- 'description' => '数据对象',
- 'type' => 'array',
- 'items' => [
- 'description' => '数据对象',
- 'example' => '[]',
- '$ref' => '#/components/schemas/PaidResourceDTO',
- ],
- 'example' => '[]',
- ],
- ],
+ [
+ 'apiName' => 'ExecuteAITeacherExpansionDialogueRefine',
+ 'description' => '执行拓展练润色',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueRefine',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'errorCodes' => [
- 500 => [
- [
- 'errorCode' => 'Server.Internal.UnknownError',
- 'errorMessage' => 'The request processing has failed due to some unknown error.',
+ [
+ 'apiName' => 'ModelRouterCreateBalanceTransaction',
+ 'description' => '客户管理/创建余额交易',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateBalanceTransaction',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantDialogue',
+ 'description' => '与AI老师进行对话',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterUpdateBillingRule',
+ 'description' => '计费管理/更新计费规则',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateBillingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterConfigureClientBalance',
+ 'description' => '客户管理/启用部门余额限流',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterConfigureClientBalance',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterChatCompletions',
+ 'description' => '聊天对话',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterChatCompletions',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CreateProject',
+ 'description' => '创建项目',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:CreateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryApiKeyList',
+ 'description' => '获取api密钥列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryApiKeyList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterBillingCostTabs',
+ 'description' => '获取用量监控Tab配置',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterBillingCostTabs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Personalizedtxt2imgQueryModelTrainJobList',
+ 'description' => '个性化文生图/查询模型训练任务列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainJobList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CountOralEvaluationStatisticsCalls',
+ 'description' => '口语评测服务调用量查询',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:countOralEvaluationStatisticsCalls',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherGrammarCheck',
+ 'description' => '执行语法检测',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherGrammarCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherSyncDialogueTranslate',
+ 'description' => '执行同步练翻译',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherSyncDialogueTranslate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AITeacherSyncPracticeTaskGenerate',
+ 'description' => '同步练对话任务生成',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:SyncPracticeTasksGenerate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryClientTree',
+ 'description' => '客户管理/获取客户树',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryClientTree',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterDeleteApiKey',
+ 'description' => '删除api密钥',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherSyncDialogue',
+ 'description' => '执行同步练',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherSyncDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Personalizedtxt2imgQueryInferenceJobInfo',
+ 'description' => '个性化文生图/查询模型推理任务的状态和结果信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryInferenceJobInfo',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantSuggestion',
+ 'description' => '获取对话中AI老师提问的建议回复内容',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantSuggestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterDeleteClient',
+ 'description' => '删除客户',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteClient',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun',
+ 'description' => '语文作文辅导',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherChineseCompositionTutoringWorkflowRun',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterGetClientBalanceLogs',
+ 'description' => '客户管理/获取部门余额变更日志',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterGetClientBalanceLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PersonalizedTextToImageQueryImageAsset',
+ 'description' => '图片资源获取',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:PersonalizedTextToImageQueryImageAsset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryApiKey',
+ 'description' => '获取api密钥信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterCreateClient',
+ 'description' => '创建客户',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateClient',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAITeacherSyncDialogueSuggestion',
+ 'description' => '获取同步练小助手提示',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:GetAITeacherSyncDialogueSuggestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherExpansionDialogueTranslate',
+ 'description' => '执行拓展练翻译',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueTranslate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetTextbookAssistantToken',
+ 'description' => '获取英语教材式AI老师功能使用授权码',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:GetTextbookAssistantToken',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryCostTrendMetrics',
+ 'description' => '获取用量趋势',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostTrendMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryBillingCostBreakdown',
+ 'description' => '计费批量明细查询',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryBillingCostBreakdown',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryObservationLogs',
+ 'description' => '查看api调用记录',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryObservationLogs',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'PersonalizedTextToImageAddInferenceJob',
+ 'description' => '添加预置模型推理任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:PersonalizedTextToImageAddPreModelInferenceJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'GetAITeacherExpansionDialogueSuggestion',
+ 'description' => '获取拓展练小助手提示',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:GetAITeacherExpansionDialogueSuggestion',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterDeleteConversation',
+ 'description' => '删除会话',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTextbookAssistantGradeVolumes',
+ 'description' => '获取拥有英语教材资源的年级列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantGradeVolumes',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterCopyApiKey',
+ 'description' => '复制api密钥',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCopyApiKey',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryNacosProviders',
+ 'description' => '获取模型标识信息',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryNacosProviders',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterCreateConversation',
+ 'description' => '创建会话',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantDifficulty',
+ 'description' => '调整AI老师回复内容的难度',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantDifficulty',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTextbookAssistantArticleDetails',
+ 'description' => '获取文章详情',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantSceneDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantTranslate',
+ 'description' => '获取对话消息的翻译结果',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantTranslate',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryPurchasedService',
+ 'description' => '查询已购买的服务',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryPurchasedService',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Personalizedtxt2imgQueryImageAsset',
+ 'description' => '个性化文生图/图片二进制内容获取',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryImageAsset',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterCreateBillingRule',
+ 'description' => '计费管理/创建计费规则',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateBillingRule',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTextbookAssistantBooks',
+ 'description' => '获取英语教材的书本',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantBooks',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTextbookAssistantArticles',
+ 'description' => '获取英语教材的文章列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantArticles',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryProjectList',
+ 'description' => '查询项目列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryProjectList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterDeleteModel',
+ 'description' => '删除模型',
+ 'operationType' => 'delete',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterDeleteModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryObservationCharts',
+ 'description' => '查看api实时监控数据',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryObservationCharts',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteAITeacherEnglishParaphraseChatMessage',
+ 'description' => '英语答疑',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteAITeacherEnglishParaphraseChatMessage',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantGrammarCheck',
+ 'description' => '获取用户回复内容的语法检测的结果',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantGrammarCheck',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList',
+ 'description' => '开放的服务能力列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServcieList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterUpdateModel',
+ 'description' => '更新模型信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterUpdateModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'QueryApplicationAccessId',
+ 'description' => '查询应用访问编号',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:QueryApplicationAccessId',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'UpdateProject',
+ 'description' => '更新项目信息',
+ 'operationType' => 'update',
+ 'ramAction' => [
+ 'action' => 'aicontent:UpdateProject',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryClientList',
+ 'description' => '获取客户信息',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryClientList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ListTextbookAssistantSceneDetails',
+ 'description' => '获取场景详情',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ListTextbookAssistantArticleDetails',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryModelList',
+ 'description' => '获取模型列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryModelList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'AliyunConsoleOpenApiQueryPaidResource',
+ 'description' => '已购买资源列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:AliyunConsoleOpenApiQueryPaidResource',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantRefineByContext',
+ 'description' => '获取润色用户回复消息内容的结果',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantRefineByContext',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantSseDialogue',
+ 'description' => 'AI老师进行对话-流式输出',
+ 'operationType' => 'none',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantSseDialogue',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryCostModelList',
+ 'description' => '获取模型用量列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostModelList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryObservationMetrics',
+ 'description' => '查看api调用报表类型信息',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryObservationMetrics',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryModel',
+ 'description' => '获取模型信息',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CountOralEvaluationStatisticsError',
+ 'description' => '口语评测服务错误码统计',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:countOralEvaluationStatisticsError',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryConversation',
+ 'description' => '获取会话详情',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'CountOralEvaluationStatisticsConcurrent',
+ 'description' => '口语评测服务并发数统计',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:countOralEvaluationStatisticsConcurrent',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Personalizedtxt2imgAddModelTrainJob',
+ 'description' => '个性化文生图/创建一个模型训练任务',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgAddModelTrainJob',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ExecuteTextbookAssistantRetryConversation',
+ 'description' => '重新生成AI老师的提问内容',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ExecuteTextbookAssistantRetryConversation',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'Personalizedtxt2imgQueryModelTrainStatus',
+ 'description' => '个性化文生图/模型训练状态查询',
+ 'operationType' => 'get',
+ 'ramAction' => [
+ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainStatus',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryNacosTags',
+ 'description' => '获取模型标签信息',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryNacosTags',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterSaveFlowConfig',
+ 'description' => '',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterSaveFlowConfig',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryConversationList',
+ 'description' => '获取会话列表',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryConversationList',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterCreateModel',
+ 'description' => '创建模型',
+ 'operationType' => 'create',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterCreateModel',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
+ ],
+ ],
+ ],
+ [
+ 'apiName' => 'ModelRouterQueryCostModelDetail',
+ 'description' => '获取模型用量明细',
+ 'operationType' => 'list',
+ 'ramAction' => [
+ 'action' => 'aicontent:ModelRouterQueryCostModelDetail',
+ 'authLevel' => 'operate',
+ 'actionConditions' => [],
+ 'resources' => [
+ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => '全部资源', 'arn' => '*'],
],
],
],
- 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"totalCount\\": 100,\\n \\"pageSize\\": 10,\\n \\"pageIndex\\": 1,\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"skip\\": 10,\\n \\"maxResults\\": 10,\\n \\"data\\": [\\n {\\n \\"instanceId\\": \\"\\",\\n \\"resourcePackageCode\\": \\"PRE_PAID_RECOURSE_PACKAGE\\",\\n \\"resourcePackageName\\": \\"智能批改-资源包\\",\\n \\"resourceCatalogCode\\": \\"AI_ORAL\\",\\n \\"resourceCatalogName\\": \\"口语评测\\",\\n \\"resourceStatus\\": \\"\\",\\n \\"quantity\\": 0,\\n \\"remainQuantity\\": 0,\\n \\"effectiveTime\\": \\"\\",\\n \\"expireTime\\": \\"\\"\\n }\\n ]\\n}","type":"json"}]',
- 'title' => '已购买资源列表',
- ],
- ],
- 'endpoints' => [
- [
- 'regionId' => 'public',
- 'endpoint' => 'aicontent.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-shanghai',
- 'endpoint' => 'aicontent.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-hangzhou',
- 'endpoint' => 'aicontent.cn-hangzhou.aliyuncs.com',
- ],
- [
- 'regionId' => 'cn-beijing',
- 'endpoint' => 'aicontent.cn-beijing.aliyuncs.com',
],
+ 'resourceTypes' => [],
],
];