diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/aicontent | |
| download | acs-metadata-full-main.tar.gz acs-metadata-full-main.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/aicontent')
| -rw-r--r-- | data/zh_cn/aicontent/20240611/api-docs.php | 10752 |
1 files changed, 10752 insertions, 0 deletions
diff --git a/data/zh_cn/aicontent/20240611/api-docs.php b/data/zh_cn/aicontent/20240611/api-docs.php new file mode 100644 index 0000000..48b1186 --- /dev/null +++ b/data/zh_cn/aicontent/20240611/api-docs.php @@ -0,0 +1,10752 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'ROA', + 'product' => 'AiContent', + 'version' => '20240611', + ], + 'directories' => [ + [ + 'id' => 204286, + 'title' => '口语评测', + 'type' => 'directory', + 'children' => [ + 'CreateAccessWarrant', + 'QueryApplicationAccessId', + 'QueryProjectList', + 'QueryProject', + 'CreateProject', + 'UpdateProject', + 'QueryPurchasedService', + ], + ], + [ + 'id' => 203174, + 'title' => 'AI语文老师', + 'type' => 'directory', + 'children' => [ + 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun', + ], + ], + [ + 'id' => 201597, + 'title' => '英语教材式AI老师', + 'type' => 'directory', + 'children' => [ + 'GetTextbookAssistantToken', + 'ListTextbookAssistantGradeVolumes', + 'ListTextbookAssistantBooks', + 'ListTextbookAssistantBookDirectories', + 'ListTextbookAssistantArticles', + 'ListTextbookAssistantArticleDetails', + 'ListTextbookAssistantSceneDetails', + 'ExecuteTextbookAssistantStartConversation', + 'ExecuteTextbookAssistantDialogue', + 'ExecuteTextbookAssistantSseDialogue', + 'ExecuteTextbookAssistantTranslate', + 'ExecuteTextbookAssistantSuggestion', + 'ExecuteTextbookAssistantDifficulty', + 'ExecuteTextbookAssistantRefineByContext', + 'ExecuteTextbookAssistantGrammarCheck', + 'ExecuteTextbookAssistantRetryConversation', + ], + ], + [ + 'id' => 200015, + 'title' => 'AI英语老师', + 'type' => 'directory', + 'children' => [ + 'ExecuteAITeacherEnglishParaphraseChatMessage', + 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun', + 'AITeacherSyncPracticeTaskGenerate', + 'ExecuteAITeacherSyncDialogue', + 'ExecuteAITeacherSyncDialogueTranslate', + 'GetAITeacherSyncDialogueSuggestion', + 'AITeacherExpansionPracticeTaskGenerate', + 'ExecuteAITeacherExpansionDialogue', + 'ExecuteAITeacherExpansionDialogueTranslate', + 'GetAITeacherExpansionDialogueSuggestion', + 'ExecuteAITeacherExpansionDialogueRefine', + 'ExecuteAITeacherGrammarCheck', + ], + ], + 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList', + [ + 'id' => 194003, + 'title' => '个性化文生图', + 'type' => 'directory', + 'children' => [ + 'PersonalizedTextToImageQueryPreModelInferenceJobInfo', + 'PersonalizedTextToImageAddInferenceJob', + 'PersonalizedTextToImageQueryImageAsset', + 'Personalizedtxt2imgQueryInferenceJobInfo', + 'Personalizedtxt2imgAddInferenceJob', + 'Personalizedtxt2imgAddModelTrainJob', + 'Personalizedtxt2imgQueryImageAsset', + 'Personalizedtxt2imgQueryModelTrainJobList', + 'Personalizedtxt2imgQueryModelTrainStatus', + ], + ], + [ + 'id' => 204289, + 'title' => '其他', + 'type' => 'directory', + 'children' => [ + 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList', + 'CountOralEvaluationStatisticsConcurrent', + 'CountOralEvaluationStatisticsCalls', + 'CountOralEvaluationStatisticsError', + 'AliyunConsoleOpenApiQueryPaidResource', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'AliyunConsoleServiceInfoDTO' => [ + 'description' => '服务信息结构体', + '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', + ], + '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', + ], + ], + ], + 'OpenApiMultiResponse' => [ + 'title' => '通用接口多数据对象返回结构体', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求编号', + 'type' => 'string', + ], + 'success' => [ + 'title' => '是否成功', + 'type' => 'boolean', + ], + 'errCode' => [ + 'title' => '错误信息编码', + 'type' => 'string', + ], + 'errMessage' => [ + 'title' => '错误信息', + 'type' => 'string', + ], + 'httpStatusCode' => [ + 'title' => 'http状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'data' => [ + 'title' => '数据列表', + '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' => '[]', + ], + ], + ], + 'OpenApiSingleResponse' => [ + 'title' => '通用接口单数据对象返回结构体', + 'type' => 'object', + 'properties' => [ + 'requestId' => [ + 'title' => '请求编号', + 'type' => 'string', + ], + 'success' => [ + 'title' => '是否成功', + 'type' => 'boolean', + ], + 'errCode' => [ + 'title' => '错误信息编码', + 'type' => 'string', + ], + 'errMessage' => [ + 'title' => '错误信息', + 'type' => 'string', + ], + 'httpStatusCode' => [ + 'title' => 'http状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'data' => [ + 'title' => '数据对象', + 'type' => 'object', + 'properties' => [ + 'modelTrainStatus' => [ + 'title' => '模型训练状态', + 'type' => 'string', + 'example' => 'FINISHED', + ], + ], + 'example' => '[]', + ], + ], + ], + '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', + ], + ], + ], + 'OralEvaluationStatisticsCallsCountResponse' => [ + 'title' => '调用量统计响应体对象', + 'description' => '调用量统计响应体对象', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'ApplicationData' => [ + 'title' => '应用数据对象列表', + 'description' => '应用数据对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用数据对象', + 'type' => 'object', + 'properties' => [ + 'applicationAccessId' => [ + 'title' => 'appkey', + 'description' => 'appkey', + 'type' => 'string', + 'required' => true, + 'example' => 'a0007g7', + ], + 'Data' => [ + 'title' => '统计项列表', + 'description' => '数据对象列表', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + 'required' => true, + ], + ], + ], + 'OralEvaluationStatisticsConcurrentCountRequest' => [ + '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', + ], + ], + ], + 'OralEvaluationStatisticsConcurrentCountResponse' => [ + 'title' => '并发数统计响应体', + 'description' => '并发数统计响应体对象', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'ApplicationData' => [ + 'title' => '应用数据对象列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'applicationAccessId' => [ + 'title' => 'appkey', + 'description' => 'appkey', + 'type' => 'string', + 'required' => true, + 'example' => 'a0007g7', + ], + 'Data' => [ + 'title' => '统计项列表', + 'description' => '数据列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据节点对象', + 'type' => 'object', + 'properties' => [ + 'name' => [ + 'title' => '统计项名称', + 'description' => '统计项名称', + 'type' => 'string', + 'required' => true, + 'example' => '2025-01', + ], + 'count' => [ + 'title' => '统计项数量', + 'description' => '统计项数量', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + ], + ], + ], + ], + ], + ], + ], + ], + 'required' => true, + ], + ], + ], + 'OralEvaluationStatisticsErrorCountRequest' => [ + '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', + ], + 'errorCode' => [ + 'title' => '错误码', + 'description' => '错误码列表', + 'type' => 'array', + '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', + ], + 'ProjectData' => [ + 'description' => '按项目汇总的统计项列表', + 'type' => 'object', + 'properties' => [ + 'applicationInternalId' => [ + 'title' => '应用内部id', + 'description' => '应用内部id', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'ApplicationData' => [ + 'description' => '应用的统计项数据对象列表', + 'type' => 'array', + 'items' => [ + 'description' => '应用的统计项数据对象', + 'type' => 'object', + 'properties' => [ + 'applicationAccessId' => [ + 'title' => 'appId,appkey', + 'description' => 'appId,appkey', + 'type' => 'string', + 'required' => true, + 'example' => 't000797', + ], + 'Data' => [ + 'description' => '数据集列表', + 'type' => 'array', + 'items' => [ + 'description' => '数据对象', + 'type' => 'object', + 'properties' => [ + 'ErrorCode' => [ + 'description' => '错误码', + 'type' => 'string', + 'example' => '51000', + ], + 'ErrorMessage' => [ + 'description' => '错误码描述信息', + 'type' => 'string', + 'example' => 'start the core unsuccessfull.', + ], + 'Data' => [ + 'description' => '统计项列表', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '口语评测', + ], + 'resourceStatus' => [ + 'title' => '资源状态', + 'description' => '资源状态', + 'type' => 'string', + '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', + ], + ], + ], + 'PaidResourceQry' => [ + 'type' => 'object', + 'properties' => [ + 'resourceStatus' => [ + 'title' => 'ALL, AVAILABLE, UNAVAILABLE', + 'type' => 'string', + ], + 'nextToken' => [ + 'type' => 'string', + ], + 'maxResults' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'Personalizedtxt2imgAddInferenceJobCmd' => [ + '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', + ], + ], + ], + 'Personalizedtxt2imgAddModelTrainJobCmd' => [ + '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, + ], + ], + ], + 'Personalizedtxt2imgInferenceJobInfoDTO' => [ + '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' => '模型推理任务结果列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'example' => '123456', + ], + 'createUserId' => [ + 'title' => '模型推理任务创建用户uid', + 'type' => 'string', + 'example' => '123456', + ], + ], + ], + 'Personalizedtxt2imgModelTrainJobInfoDTO' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '模型训练任务id', + 'type' => 'string', + 'example' => '123456', + ], + 'Name' => [ + 'type' => 'string', + ], + 'ObjectType' => [ + 'type' => 'string', + ], + 'ImageUrl' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'JobStatus' => [ + 'type' => 'string', + ], + 'InferenceJobList' => [ + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/Personalizedtxt2imgInferenceJobInfoDTO', + ], + ], + 'CreateTime' => [ + 'type' => 'string', + ], + 'CreateUserId' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'apis' => [ + 'CreateAccessWarrant' => [ + 'summary' => '阿里云控制台/授权凭证创建。', + 'path' => '/api/v1/aliyunConsole/createAccessWarrant', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '259954', + 'abilityTreeNodes' => [ + 'FEATUREaioralV0UKKO', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'WarrantCreateCmd', + 'description' => 'WarrantCreateCmd', + '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', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '1672531200', + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'applicationAccessId', + 'in' => 'query', + 'schema' => [ + 'title' => '应用识别码、appkey', + 'description' => '应用访问识别码(appkey)', + 'type' => 'string', + 'required' => false, + 'example' => '1234567890', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '259876', + 'abilityTreeNodes' => [ + 'FEATUREaioralV0UKKO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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', + ], + ], + ], + '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', + ], + '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' => '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', + ], + ], + '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' => '鉴权失败或权限不足', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '259770', + 'abilityTreeNodes' => [ + 'FEATUREaioralV0UKKO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'title' => 'ProjectCreateCmd', + 'description' => 'ProjectCreateCmd', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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', + ], + ], + '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" + .'}', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '259771', + 'abilityTreeNodes' => [ + 'FEATUREaioralV0UKKO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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', + ], + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + '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" + .'}', + ], + ], + ], + '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', + ], + 'security' => [ + [ + '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' => '[]', + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '264494', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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' => '春天的景色', + ], + 'essayType' => [ + 'title' => '作文类型', + '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'."\n", + ], + 'responseMode' => [ + 'title' => '数据响应方式', + 'description' => '数据响应方式', + 'type' => 'string', + 'required' => true, + 'example' => 'streaming', + 'enum' => [ + 'streaming', + ], + ], + 'userId' => [ + 'title' => '用户名', + 'description' => '用户名', + 'type' => 'string', + 'required' => true, + 'example' => 'xxxxxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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' => '春天里常见的景', + ], + ], + ], + ], + 401 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'errMsg' => [ + 'type' => 'string', + ], + 'errCode' => [ + 'type' => 'string', + ], + 'success' => [ + 'type' => 'string', + ], + 'httpStatusCode' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"春天里常见的景\\"\\n}","type":"json"}]', + 'title' => '语文作文辅导', + 'requestParamsDescription' => '1：请求参数中的系统参数无需填入'."\n" + ."\n" + .'2：按照描述内容确定参数是否必传', + 'responseParamsDescription' => '输出示例：'."\n" + ."\n" + .'data:{"event":"start"}'."\n" + ."\n" + .'data:{"event":"message","content":"###"}'."\n" + ."\n" + .'data:{"event":"message","content":" "}'."\n" + ."\n" + .'data:{"event":"message","content":"作文"}'."\n" + ."\n" + .'data:{"event":"message","content":"分析 \\n- **"}'."\n" + ."\n" + .'data:{"event":"message","content":"春天里常见的景"}'."\n" + ."\n" + .'data:{"event":"message","content":"的喜爱之情。"}'."\n" + ."\n" + .'data:{"event":"end"}', + ], + 'GetTextbookAssistantToken' => [ + 'summary' => '获取请求调用授权码。', + 'path' => '/api/v1/textbookAssistant/teachingResource/GetToken', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [], + 'produces' => [], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '261955', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体对象。', + 'type' => 'object', + 'properties' => [ + 'deviceId' => [ + 'description' => '设备ID。', + 'type' => 'string', + 'required' => true, + 'example' => '700d4d9411efbe6e0', + ], + 'model' => [ + 'description' => '设备型号。', + 'type' => 'string', + 'required' => true, + 'example' => '25032PS56C', + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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老师功能使用授权码', + ], + 'ListTextbookAssistantGradeVolumes' => [ + 'summary' => '获取拥有英语教材资源的年级列表。', + 'path' => '/api/v1/textbookAssistant/teachingResource/ListGradeVolumes', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '261927', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体对象。', + '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', + ], + ], + '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' => [ + 'textbookVersion' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Sychro' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '261982', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体对象。', + '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', + ], + '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, + ], + ], + ], + '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' => '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' => '返回数据对象。', + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取英语教材的书本', + ], + 'ListTextbookAssistantBookDirectories' => [ + 'summary' => '获取书本下的目录信息。', + 'path' => '/api/v1/textbookAssistant/teachingResource/ListBookDirectories', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '261983', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体对象。', + '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：同步练习', + ], + 'example' => 'SYNC', + 'default' => 'SYNC', + 'enum' => [ + 'SYNC', + 'EXPAND', + 'ALL', + ], + ], + 'authToken' => [ + 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', + ], + ], + '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' => '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' => '身边事物环境', + ], + ], + ], + ], + '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' => '可能存在的子元素，兼容数据使用，不一定存在', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '261984', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体对象。', + 'type' => 'object', + 'properties' => [ + 'directoryId' => [ + 'description' => '目录ID。可以通过获取教材目录接口获取', + 'type' => 'string', + 'required' => true, + 'example' => '90aa861b4d9311efbe6e0c42a106bb02', + ], + 'authToken' => [ + 'description' => '消息临时授权码,可以通过获取服务窗消息发送授权码接口获取。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'tc_a893b8492c4be046cbc906c566aeb8c9', + ], + ], + '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' => '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', + ], + 'data' => [ + 'description' => '请求返回结果。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'articleId' => [ + 'description' => '文章ID', + 'type' => 'string', + 'example' => '0c05700d4d9411efbe6e0c42a106bb02', + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '262952', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数', + 'type' => 'object', + 'properties' => [ + '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, + ], + ], + ], + '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' => [ + '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' => '令人愉快的；友好的', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '262951', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数', + 'type' => 'object', + 'properties' => [ + 'authToken' => [ + 'description' => '接口调用授权码,可以通过获取"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', + ], + 'sceneIdList' => [ + 'description' => '场景ID列表', + 'type' => 'array', + 'items' => [ + 'description' => '场景ID', + 'type' => 'string', + 'required' => false, + 'example' => '38c41b7b509911efbe6e0c42a106bb02', + ], + 'required' => false, + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '261985', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数。', + 'type' => 'object', + 'properties' => [ + 'authToken' => [ + 'description' => '接口调用授权码，可以通过"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', + ], + 'scenario' => [ + 'description' => '选择场景。'."\n" + ."\n" + .'SYNC：同步练习'."\n" + ."\n" + .'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', + ], + ], + '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' => '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' => '结果消息数据', + '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' => '根据文章，迈克·布莱克是如何介绍自己的？', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '261986', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + 'userMessage' => [ + 'description' => '用户回复消息内容', + 'type' => 'string', + 'required' => true, + 'example' => 'Hello', + ], + 'authToken' => [ + 'description' => '接口调用授权码，可以通过"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => '6788e0b475a4631ffc626722', + ], + ], + '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' => '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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老师进行对话', + ], + 'ExecuteTextbookAssistantSseDialogue' => [ + 'summary' => '进行对话-流式输出', + 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteSseDialogue', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '268248', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数', + 'type' => 'object', + 'properties' => [ + 'scenario' => [ + 'title' => '选择场景。SYNC：同步练习，EXPAND：拓展练习', + 'description' => '选择场景。SYNC：同步练习，EXPAND：拓展练习', + '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', + ], + ], + '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', + ], + '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', + ], + ], + ], + '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' => '执行对话流式输出服务错误，请重试:资源信息不存在', + ], + ], + ], + ], + 401 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'type' => 'string', + ], + 'errCode' => [ + 'type' => 'string', + ], + 'errMessage' => [ + 'type' => 'string', + ], + 'requestId' => [ + 'type' => 'string', + ], + ], + ], + ], + 403 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '261987', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'data' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '获取结果数据结构体', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '翻译结果数据', + 'type' => 'string', + 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取对话消息的翻译结果', + ], + 'ExecuteTextbookAssistantSuggestion' => [ + 'summary' => '获取鉴权参数', + 'path' => '/api/v1/textbookAssistant/dialogue/Suggestion', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '262023', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数', + 'type' => 'object', + 'properties' => [ + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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', + ], + 'data' => [ + 'description' => '返回数据对象', + 'type' => 'object', + 'properties' => [ + 'result' => [ + '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' => '根据文章，迈克·布莱克是如何介绍自己的？', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'string', + ], + 'RequesId' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Synchro' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'Code' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '262151', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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' => '6788f4a6b54c5268c1b78a25', + ], + 'authToken' => [ + 'description' => '接口调用授权码，可以通过"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', + ], + 'action' => [ + 'description' => '调整难度的类型', + 'type' => 'string', + 'required' => true, + 'example' => 'UP', + 'enum' => [ + 'UP', + 'DOWN', + ], + ], + ], + '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' => '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' => '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?', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'type' => 'string', + ], + 'RequestId' => [ + 'type' => 'string', + ], + 'Synchro' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'Code' => [ + 'type' => 'string', + ], + 'Message' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '262154', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + 'user' => [ + 'description' => '用户回复消息的编号', + 'type' => 'string', + 'required' => true, + 'example' => '6788e0b45bdfc807f077a5a1', + ], + 'authToken' => [ + 'description' => '接口调用授权码，可以通过"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', + ], + ], + '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' => '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' => '获取结果数据结构体', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '结果数据', + 'type' => 'object', + 'properties' => [ + 'result' => [ + 'description' => '润色用户内容的结果', + 'type' => 'string', + 'example' => 'Good evening! From the book, how does Mike Black introduce himself?', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取润色用户回复消息内容的结果', + ], + 'ExecuteTextbookAssistantGrammarCheck' => [ + 'summary' => '语法检测', + 'path' => '/api/v1/textbookAssistant/dialogue/ExecuteGrammarCheck', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '262153', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + 'user' => [ + 'description' => '用户回复消息编号', + 'type' => 'string', + 'required' => true, + 'example' => '6788e0b45bdfc807f077a5a1', + ], + 'authToken' => [ + 'description' => '接口调用授权码，可以通过"英语教材式AI老师功能使用授权码"接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', + ], + ], + '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' => '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '262152', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + ], + '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' => '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' => '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?', + ], + 'chineseResult' => [ + 'description' => 'AI老师的中文回复', + 'type' => 'string', + 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', + ], + ], + ], + ], + ], + ], + ], + ], + 403 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'type' => 'string', + ], + 'Success' => [ + 'type' => 'string', + ], + 'Message' => [ + 'type' => 'string', + ], + 'Synchro' => [ + 'type' => 'string', + ], + 'Data' => [ + 'type' => 'string', + ], + 'Code' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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老师的提问内容', + ], + 'ExecuteAITeacherEnglishParaphraseChatMessage' => [ + 'summary' => '英语答疑', + 'path' => '/pop/api/v1/intelligentAgent/englishParaphrase/chatMessage', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'produces' => [], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '264496', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数', + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应体', + 'type' => 'object', + 'properties' => [ + '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', + ], + 'errCode' => [ + 'type' => 'string', + ], + 'errMsg' => [ + 'type' => 'string', + ], + 'httpStatusCode' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + 'sse', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '264493', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求body参数', + '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' => '用户名', + 'type' => 'string', + 'required' => true, + 'example' => 'xxxxxxx', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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' => 'hi', + ], + ], + ], + ], + 401 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'success' => [ + 'type' => 'string', + ], + 'errCode' => [ + 'type' => 'string', + ], + 'errMsg' => [ + 'type' => 'string', + ], + 'httpStatusCode' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '258598', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + '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', + ], + 'data' => [ + 'description' => '数据对象', + 'type' => 'object', + 'properties' => [ + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '259253', + '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' => [ + '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, + ], + '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', + ], + 'userId' => [ + 'title' => '用户Id', + 'description' => '用户Id', + 'type' => 'string', + 'required' => true, + 'example' => '886eba3702xxxxxxxxx4ba52a87a525', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '数据对象', + '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', + ], + ], + '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 \\"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', + ], + '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' => [ + '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, + ], + '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, + ], + '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' => [ + 'result' => [ + 'title' => '翻译结果', + 'description' => '翻译结果', + 'type' => 'string', + 'example' => '太好了，谢谢你过来，莉莉。你喜欢吃肉吗？', + ], + ], + '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 \\"result\\": \\"太好了，谢谢你过来，莉莉。你喜欢吃肉吗？\\"\\n }\\n}","type":"json"}]', + 'title' => '执行同步练翻译', + ], + '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' => [ + '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', + ], + ], + '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' => [ + 'englishResult' => [ + 'title' => '小助手的英文提示', + 'description' => '小助手的英文提示', + 'type' => 'string', + 'example' => 'Thanks, Lily. Do you like meat, Lily?', + ], + 'chineseResult' => [ + 'title' => '小助手的中文提示', + 'description' => '小助手的中文提示', + 'type' => 'string', + 'example' => '谢谢莉莉.你喜欢吃肉吗，莉莉？', + ], + ], + '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 \\"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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '258684', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结构体', + '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', + ], + 'data' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '拓展练对话任务生成', + ], + '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' => [ + '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' => '角色设置', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiSingleResponse<AITeacherExpansionTrainDTO>', + 'description' => 'OpenApiSingleResponse<AITeacherExpansionTrainDTO>', + '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' => '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' => '[]', + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + '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, + ], + '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, + ], + '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, + ], + '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' => [ + 'result' => [ + 'title' => '翻译结果', + 'description' => '翻译结果', + 'type' => 'string', + 'example' => '太好了，谢谢你过来，莉莉。你喜欢吃肉吗？', + ], + ], + '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 \\"result\\": \\"太好了，谢谢你过来，莉莉。你喜欢吃肉吗？\\"\\n }\\n}","type":"json"}]', + 'title' => '执行拓展练翻译', + ], + 'GetAITeacherExpansionDialogueSuggestion' => [ + 'summary' => '拓展练小助手。', + 'path' => '/api/v1/aiteacher/expansionPractice/suggestion', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '259938', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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' => 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' => '角色设置', + '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, + ], + ], + ], + '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' => [ + 'englishResult' => [ + 'title' => '小助手的英文提示', + 'description' => '小助手的英文提示', + 'type' => 'string', + 'example' => 'Thanks, Lily. Do you like meat, Lily?', + ], + 'chineseResult' => [ + 'title' => '小助手的中文提示', + 'description' => '小助手的中文提示', + 'type' => 'string', + 'example' => '谢谢莉莉.你喜欢吃肉吗，莉莉？', + ], + ], + '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 \\"englishResult\\": \\"Thanks, Lily. Do you like meat, Lily?\\",\\n \\"chineseResult\\": \\"谢谢莉莉.你喜欢吃肉吗，莉莉？\\"\\n }\\n}","type":"json"}]', + 'title' => '获取拓展练小助手提示', + ], + 'ExecuteAITeacherExpansionDialogueRefine' => [ + 'summary' => '拓展练根据上下文进行润色。', + 'path' => '/api/v1/aiteacher/expansionPractice/refineByContext', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '259939', + 'abilityTreeNodes' => [ + 'FEATUREaioralKM5ZTF', + ], + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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' => 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, + ], + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiSingleResponse<AITeacherOpenApiRefineDTO>', + 'description' => 'OpenApiSingleResponse<AITeacherOpenApiRefineDTO>', + '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' => [ + 'result' => [ + 'title' => '润色结果', + 'description' => '润色结果', + 'type' => 'string', + 'example' => 'Yes, I\'ll be right there.', + ], + ], + '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 \\"result\\": \\"Yes, I\'ll be right there.\\"\\n }\\n}","type":"json"}]', + 'title' => '执行拓展练润色', + ], + 'ExecuteAITeacherGrammarCheck' => [ + 'summary' => '语法检测。', + 'path' => '/api/v1/aiteacher/common/grammarChecking', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => '执行语法检测', + ], + 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList' => [ + 'summary' => '阿里云控制台/列出阿里云控制台上可使用的服务列表。', + 'path' => '/api/v1/aliyunConsole/queryAliyunConsoleServiceList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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' => '鉴权失败或权限不足', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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' => '服务列表查询', + ], + 'PersonalizedTextToImageQueryPreModelInferenceJobInfo' => [ + 'summary' => '个性化文生图/查询预制模型推理任务的状态。', + 'path' => '/api/v1/personalizedtxt2img/queryPreModelInferenceJobInfo', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'inferenceJobId', + 'in' => 'query', + 'schema' => [ + 'title' => '推理任务编号', + 'description' => '推理任务编号', + 'type' => 'string', + 'required' => true, + 'example' => 'girl-xxxx-xxxx-xxxx-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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' => [ + 'description' => '图片资源编号', + 'type' => 'string', + 'example' => '0000.png', + ], + 'example' => '0000.png', + ], + 'createTime' => [ + 'title' => '模型推理任务创建时间', + 'description' => '模型推理任务创建时间', + 'type' => 'string', + 'example' => '2023-12-25T12:00:00', + ], + ], + '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"}', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', + 'errorMessage' => '必要参数没有找到', + ], + ], + 403 => [ + [ + 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', + 'errorMessage' => '鉴权失败或权限不足', + ], + ], + [ + [ + 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', + 'errorMessage' => '资源没有找到', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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' => '查询预置模型推理任务信息', + ], + 'PersonalizedTextToImageAddInferenceJob' => [ + 'summary' => '个性化文生图/基于一个预训练模型创建图片推理任务。', + 'path' => '/api/v1/personalizedtxt2img/addPreModelInferenceJob', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体对象。', + 'type' => 'object', + 'properties' => [ + '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', + ], + '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', + '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + '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' => [ + 'description' => '模型推理任务结果列表', + 'type' => 'string', + 'example' => '0000.png', + ], + 'example' => '0000.png', + ], + 'createTime' => [ + 'title' => '模型推理任务创建时间', + 'description' => '模型推理任务创建时间', + 'type' => 'string', + 'example' => '2023-12-25T12:00:00', + ], + ], + 'example' => '[]', + ], + ], + 'example' => '{"success":true,"errCode":null,"errMessage":null,"requestId":"abec5678-3536-4808-ab5a-eb165cd9109f","data":{"id":"1","promptId":"prompt_id-xxxx-xxxx-xxxx-xxxx","modelId":"model_id-xxxx-xxxx-xxxx-xxxx","jobStatus":"WAIT_SCHEDULE","resultImageUrl":null,"createUserId":"109988888888","createTime":"2024-06-28T11:02:32.441184"}}'."\n", + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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' => '添加预置模型推理任务', + ], + 'PersonalizedTextToImageQueryImageAsset' => [ + 'summary' => '个性化文生图/通过唯一的图片编号获取图片内容。', + 'path' => '/api/v1/personalizedtxt2img/queryImageAssetFromImageId', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'imageId', + 'in' => 'query', + 'schema' => [ + 'title' => '图片编号', + 'description' => '图片编号', + 'type' => 'string', + 'required' => true, + 'example' => '0000.png', + ], + ], + [ + 'name' => 'encodeFormat', + 'in' => 'query', + 'schema' => [ + 'title' => '图片编码格式', + 'description' => '图片编码格式', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + 'enum' => [ + 'base64', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Object', + 'description' => 'Object', + 'type' => 'any', + 'example' => 'BinaryData', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', + 'errorMessage' => '必要参数没有找到', + ], + ], + 403 => [ + [ + 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', + 'errorMessage' => '鉴权失败或权限不足', + ], + ], + [ + [ + 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', + 'errorMessage' => '资源没有找到', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]', + 'title' => '图片资源获取', + ], + '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' => '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', + ], + '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' => '必要参数没有找到', + ], + ], + 403 => [ + [ + 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', + 'errorMessage' => '鉴权失败或权限不足', + ], + ], + [ + [ + 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', + 'errorMessage' => '资源没有找到', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '226451', + 'abilityTreeNodes' => [ + 'FEATUREaioral4PZ00K', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + 'example' => '0000.png', + ], + 'createTime' => [ + 'title' => '模型推理任务创建时间', + 'description' => '模型推理任务创建时间', + 'type' => 'string', + 'example' => '2023-12-25T12:00:00', + ], + ], + 'example' => '[]', + ], + ], + 'example' => '{"success":true,"errCode":null,"errMessage":null,"requestId":"abec5678-3536-4808-ab5a-eb165cd9109f","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"}}'."\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 \\"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' => '个性化文生图/基于一个模型创建图片推理任务', + ], + 'Personalizedtxt2imgAddModelTrainJob' => [ + 'summary' => '个性化文生图/创建一个模型训练任务。', + 'path' => '/api/v1/personalizedtxt2img/addModelTrainJob', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '226450', + 'abilityTreeNodes' => [ + 'FEATUREaioral4PZ00K', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + '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', + ], + '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', + ], + 'required' => true, + ], + 'trainSteps' => [ + 'title' => '模型训练任务训练步骤', + 'description' => '模型训练任务训练步骤', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '800', + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiSingleResponse<ModelTrainJobInfoDTO>', + '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' => '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", + ], + ], + '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', + ], + 'inferenceJobList' => [ + 'title' => '模型推理任务列表', + 'description' => '模型推理任务列表', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + 'inferenceImageCount' => [ + 'title' => '该模型总推理图片数量', + 'description' => '该模型总推理图片数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'createTime' => [ + 'title' => '模型训练任务创建时间', + 'description' => '模型训练任务创建时间', + 'type' => 'string', + 'example' => '2023-12-25T12:00:00', + ], + ], + 'example' => '[]', + ], + ], + 'example' => '{"success":true,"errCode":null,"errMessage":null,"requestId":"8f6b1cd2-5390-478a-9968-2a5678601df5","data":{"id":"2","name":"熊猫图片生成","objectType":"panda","imageUrl":["https://pic1.zhimg.com/v2-6154d925bcebd8b41a30051695e5a134_720w.jpg","https://k.sinaimg.cn/n/tech/crawl/114/w550h364/20211103/24e2-2bc49a39210ce2ac520c876dcaee7bcd.jpg/w700d1q75cms.jpg"],"jobStatus":"NOT_START","inferenceJobList":null,"inferenceImageCount":0,"createTime":"2024-06-28T11:02:32.0598209"}}'."\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 \\"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' => '个性化文生图/创建一个模型训练任务', + ], + 'Personalizedtxt2imgQueryImageAsset' => [ + 'summary' => '个性化文生图/图片二进制内容获取。', + 'path' => '/api/v1/personalizedtxt2img/queryImageAsset', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'modelId', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'imageId', + 'in' => 'query', + 'schema' => [ + 'title' => '图片编号', + 'description' => '图片编号', + 'type' => 'string', + 'required' => true, + 'example' => '0000.png', + ], + ], + [ + 'name' => 'encodeFormat', + 'in' => 'query', + 'schema' => [ + 'title' => '图片编码格式', + 'description' => '图片编码格式', + 'type' => 'string', + 'required' => false, + 'example' => 'base64', + 'enum' => [ + 'base64', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Object', + 'description' => 'Object', + 'type' => 'any', + 'example' => 'BinaryData', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', + 'errorMessage' => '必要参数没有找到', + ], + ], + 403 => [ + [ + 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', + 'errorMessage' => '鉴权失败或权限不足', + ], + ], + [ + [ + 'errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', + 'errorMessage' => '资源没有找到', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]', + 'title' => '个性化文生图/图片二进制内容获取', + ], + 'Personalizedtxt2imgQueryModelTrainJobList' => [ + 'summary' => '个性化文生图/查询模型训练任务列表。', + 'path' => '/api/v1/personalizedtxt2img/queryModelTrainJobList', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '226449', + 'abilityTreeNodes' => [ + 'FEATUREaioral4PZ00K', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMultiResponse<ModelTrainJobInfoDTO>', + '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' => [ + '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", + ], + ], + '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', + ], + 'inferenceJobList' => [ + 'title' => '模型推理任务列表', + 'description' => '模型推理任务列表', + 'type' => 'array', + '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', + ], + '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', + ], + ], + ], + ], + 'inferenceImageCount' => [ + 'title' => '该模型总推理图片数量', + 'description' => '该模型总推理图片数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'createTime' => [ + 'title' => '模型训练任务创建时间', + 'description' => '模型训练任务创建时间', + 'type' => 'string', + 'example' => '2023-12-25T12:00:00', + ], + ], + ], + 'example' => '[]', + ], + ], + 'example' => '{"data":[{"jobStatus":"FINISHED","createTime":"2024-07-11T20:50:11.484557","imageUrl":["https://aicontent-oneconsole-test.oss-cn-shanghai.aliyuncs.com/1662672261163207/oneconsole/aiservice/personalizedtxt2img/1662672261163207/205269385397348915/model/sourceimage/2024-07-11-1720702195-47856852.png"],"name":"小女孩测试模型","id":"girl_1c5713ec-3f84-11ef-a7fd-954b0578482b","inferenceJobList":[{"jobStatus":"FINISHED","modelId":"girl_1c5713ec-3f84-11ef-a7fd-954b0578482b","resultImageUrl":["0000.png","0001.png"],"createTime":"2024-07-11T20:57:57.132052","promptId":"31df3dc4-3f85-11ef-a7fd-954b0578482b","id":"19","jobTrainProgress":1}],"objectType":"girl","inferenceImageCount":2},{"jobStatus":"WAIT_SCHEDULE","createTime":"2024-07-12T14:39:03.131210","imageUrl":["https://aicontent-oneconsole-test.oss-cn-shanghai.aliyuncs.com/1662672261163207/oneconsole/aiservice/personalizedtxt2img/1662672261163207/205269385397348915/model/sourceimage/2024-07-12-1720766310-39948158.png"],"name":"卡通女孩模型训练20240712","id":"girl_6dcc62b4-4019-11ef-a7fd-954b0578482b","inferenceJobList":[],"objectType":"girl","inferenceImageCount":0}],"success":true,"requestId":"497A1126-360D-1FE4-8DDB-E0740CFFECA4","notEmpty":true,"empty":false,"errCode":null,"errMessage":null}'."\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 \\"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' => '个性化文生图/查询模型训练任务列表', + ], + 'Personalizedtxt2imgQueryModelTrainStatus' => [ + 'summary' => '个性化文生图/模型训练状态查询。', + 'path' => '/api/v1/personalizedtxt2img/queryModelTrainStatus', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'modelId', + 'in' => 'query', + 'schema' => [ + 'title' => '模型Id', + 'description' => '模型编号', + 'type' => 'string', + 'required' => true, + 'example' => 'modelId-xxxx-xxxx-xxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiSingleResponse<ModelTrainStatusDTO>', + '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' => [ + 'modelTrainStatus' => [ + 'title' => '模型训练状态', + 'description' => '模型训练状态', + 'type' => 'string', + 'example' => 'FINISHED', + ], + ], + 'example' => '[]', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', + 'errorMessage' => '必要参数没有找到', + ], + ], + 403 => [ + [ + 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', + 'errorMessage' => '鉴权失败或权限不足', + ], + ], + [ + [ + 'errorCode' => 'B_MODEL_TRAIN_JOB_NOT_EXIST', + 'errorMessage' => '模型训练任务不存在', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + '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' => '鉴权失败或权限不足', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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', + ], + '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' => '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', + ], + '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\\": \\"\\",\\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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '260346', + 'abilityTreeNodes' => [ + 'FEATUREaioralV0UKKO', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'body', + 'in' => 'body', + 'style' => 'json', + 'schema' => [ + 'description' => '请求体参数', + 'required' => false, + '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountRequest', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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\\": \\"\\",\\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', + ], + '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' => 'array', + 'items' => [ + 'description' => '口语评测服务错误码响应体对象', + '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountResponse', + ], + 'example' => '[]', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', + 'errorMessage' => '鉴权失败或权限不足', + ], + ], + 500 => [ + [ + 'errorCode' => 'UNKNOWN_ERROR', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + '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', + ], + ], + ], + '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' => '[]', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'Server.Internal.UnknownError', + 'errorMessage' => 'The request processing has failed due to some unknown error.', + ], + ], + ], + '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', + ], + ], +]; |