'1.0', 'info' => ['style' => 'ROA', 'product' => 'AiContent', 'version' => '20240611'], 'directories' => [ [ 'children' => [ 'ModelRouterCreateBalanceTransaction', 'ModelRouterGetClientBalanceLogs', 'ModelRouterGetClientBalance', 'ModelRouterConfigureClientBalance', 'ModelRouterQueryUsageBreakdown', 'ModelRouterQueryBillingCostBreakdown', 'ModelRouterUpdateBillingRule', 'ModelRouterQueryClientTree', 'ModelRouterQueryClientDiscountLogs', 'ModelRouterQueryBillingRuleList', 'ModelRouterCreateBillingRule', 'ModelRouterBillingCostTabs', 'ModelRouterQueryCostOverviewMetrics', 'ModelRouterQueryCostTrendMetrics', 'ModelRouterQueryCostModelList', 'ModelRouterQueryCostModelDetail', 'ModelRouterCreateModel', 'ModelRouterUpdateModel', 'ModelRouterUpdateConversation', 'ModelRouterUpdateClient', 'ModelRouterQueryObservationMetrics', 'ModelRouterQueryObservationLogs', 'ModelRouterQueryObservationCharts', 'ModelRouterQueryNacosTags', 'ModelRouterQueryNacosProviders', 'ModelRouterQueryModelList', 'ModelRouterQueryModel', 'ModelRouterQueryConversationList', 'ModelRouterQueryConversation', 'ModelRouterQueryClientList', 'ModelRouterQueryApiKeyList', 'ModelRouterQueryApiKey', 'ModelRouterDeleteModel', 'ModelRouterDeleteClient', 'ModelRouterDeleteConversation', 'ModelRouterDeleteApiKey', 'ModelRouterCreateApiKey', 'ModelRouterCreateClient', 'ModelRouterCreateConversation', 'ModelRouterChatCompletions', 'ModelRouterCopyApiKey', ], 'type' => 'directory', 'title' => 'Model Router', ], [ 'children' => ['CreateAccessWarrant', 'QueryApplicationAccessId', 'QueryProjectList', 'QueryProject', 'CreateProject', 'UpdateProject', 'QueryPurchasedService'], 'type' => 'directory', 'title' => 'Spoken language assessment', ], [ 'children' => ['ExecuteAITeacherChineseCompositionTutoringWorkflowRun'], 'type' => 'directory', 'title' => 'AI chinese language teacher', ], [ 'children' => ['GetTextbookAssistantToken', 'ListTextbookAssistantGradeVolumes', 'ListTextbookAssistantBooks', 'ListTextbookAssistantBookDirectories', 'ListTextbookAssistantArticles', 'ListTextbookAssistantArticleDetails', 'ListTextbookAssistantSceneDetails', 'ExecuteTextbookAssistantStartConversation', 'ExecuteTextbookAssistantDialogue', 'ExecuteTextbookAssistantSseDialogue', 'ExecuteTextbookAssistantTranslate', 'ExecuteTextbookAssistantSuggestion', 'ExecuteTextbookAssistantDifficulty', 'ExecuteTextbookAssistantRefineByContext', 'ExecuteTextbookAssistantGrammarCheck', 'ExecuteTextbookAssistantRetryConversation'], 'type' => 'directory', 'title' => 'AI english textbook-style teacher', ], [ 'children' => ['ExecuteAITeacherEnglishParaphraseChatMessage', 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun', 'AITeacherSyncPracticeTaskGenerate', 'ExecuteAITeacherSyncDialogue', 'ExecuteAITeacherSyncDialogueTranslate', 'GetAITeacherSyncDialogueSuggestion', 'AITeacherExpansionPracticeTaskGenerate', 'ExecuteAITeacherExpansionDialogue', 'ExecuteAITeacherExpansionDialogueTranslate', 'GetAITeacherExpansionDialogueSuggestion', 'ExecuteAITeacherExpansionDialogueRefine', 'ExecuteAITeacherGrammarCheck'], 'type' => 'directory', 'title' => 'AI english teacher', ], [ 'children' => ['AliyunConsoleOpenApiQueryAliyunConsoleServcieList', 'CountOralEvaluationStatisticsConcurrent', 'CountOralEvaluationStatisticsCalls', 'CountOralEvaluationStatisticsError', 'AliyunConsoleOpenApiQueryPaidResource', 'Personalizedtxt2imgAddInferenceJob', 'Personalizedtxt2imgAddModelTrainJob', 'Personalizedtxt2imgQueryModelTrainJobList', 'Personalizedtxt2imgQueryInferenceJobInfo', 'Personalizedtxt2imgQueryModelTrainStatus', 'Personalizedtxt2imgQueryImageAsset', 'PersonalizedTextToImageQueryPreModelInferenceJobInfo', 'PersonalizedTextToImageQueryImageAsset', 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList', 'PersonalizedTextToImageAddInferenceJob', 'ModelRouterSaveFlowConfig'], 'type' => 'directory', 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'AliyunConsoleServiceInfoDTO' => [ 'description' => 'Contains details about the service.', 'type' => 'object', 'properties' => [ 'serviceCode' => ['title' => '服务编码', 'description' => 'The unique code for the service.', 'type' => 'string', 'example' => 'online_ai_algorithm_personalized_text_to_image_call_count'], 'serviceName' => ['title' => '服务名称', 'description' => 'The display name of the service.', 'type' => 'string', 'example' => 'AI算法模型-个性化文生图-在线按量调用'], 'freeCount' => ['title' => '体验调用量', 'description' => 'The number of free API calls available.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'freeConcurrencyCount' => ['title' => '体验并发数', 'description' => 'The maximum number of concurrent requests allowed for the free trial.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'documentUrl' => ['title' => '官网文档url', 'description' => 'The URL of the service documentation.', 'type' => 'string', 'example' => 'https://www.aliyun.com/product/ai-algorithm'], 'buyUrl' => ['title' => '服务开通url', 'description' => 'The URL to activate the service.', 'type' => 'string', 'example' => 'https://www.aliyun.com/product/ai-algorithm'], ], 'title' => '', 'example' => '', ], 'ApiKeyCreateCmd' => [ 'type' => 'object', 'properties' => [ 'clientId' => ['title' => '客户ID，null表示默认客户', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ApiKeyDecryptedDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'name' => ['title' => '密钥名称', 'type' => 'string', 'example' => 'MyApiKey', 'description' => ''], 'key' => ['title' => '完整密钥', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxxxxxxx', 'description' => ''], 'client' => ['title' => '关联的客户信息', '$ref' => '#/components/schemas/ClientDTO', 'description' => '', 'example' => ''], 'keyPreview' => ['title' => '密钥预览', 'type' => 'string', 'example' => 'sk-xxx****xxx', 'description' => ''], 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ApiKeyDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'name' => ['title' => '密钥名称', 'type' => 'string', 'example' => 'MyApiKey', 'description' => ''], 'client' => ['title' => '关联的客户信息', '$ref' => '#/components/schemas/ClientDTO', 'description' => '', 'example' => ''], 'keyPreview' => ['title' => '密钥预览', 'type' => 'string', 'example' => 'sk-xxx****xxx', 'description' => ''], 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ApiKeyListQry' => [ 'type' => 'object', 'properties' => [ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'keyword' => ['title' => '搜索关键字', 'type' => 'string', 'description' => '', 'example' => ''], 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'description' => ''], 'clientId' => ['title' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ApiKeyUpdateCmd' => [ 'type' => 'object', 'properties' => [ 'name' => ['title' => '密钥名称', 'type' => 'string', 'example' => 'MyApiKey', 'description' => ''], 'status' => ['title' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'BatchCreateModelItemDTO' => [ 'type' => 'object', 'properties' => [ 'name' => ['title' => '模型名称（必填，建议同标识重复时手动加 -v1/-v2 区分）', 'type' => 'string', 'required' => true, 'example' => 'qwen-max'], 'modelId' => ['title' => '模型标识（必填，对应厂商侧 model id；同标识重复时由后端自动按 v1/v2 递增 version）', 'type' => 'string', 'required' => true, 'example' => 'qwen-max'], 'modelType' => ['title' => '模型类型（必填）。可选枚举：Chat / Embedding / Rerank / Image / Audio / Video', 'type' => 'string', 'required' => true, 'example' => 'Chat'], 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问 Max'], 'maxInputLength' => ['title' => '最大输入长度（token 数）', 'type' => 'string', 'example' => '128000'], 'maxOutputLength' => ['title' => '最大输出长度（token 数）', 'type' => 'string', 'example' => '8192'], 'inOut' => ['title' => '支持的输入输出数据类型，逗号分隔', 'type' => 'string', 'example' => 'text'], 'extensions' => ['title' => '扩展配置参数，JSON 字符串', 'type' => 'string', 'example' => '{}'], 'tags' => ['title' => '标签，逗号分隔', 'type' => 'string', 'example' => 'chat,NLP'], ], ], 'BatchModelErrorDTO' => [ 'type' => 'object', 'properties' => [ 'modelId' => ['title' => '模型标识', 'type' => 'string', 'example' => 'qwen-max'], 'name' => ['title' => '模型名称', 'type' => 'string', 'example' => 'qwen-max'], 'errorMsg' => ['title' => '失败原因', 'type' => 'string', 'example' => '模型类型不能为空'], ], ], 'BillingBillSummaryPointDTO' => [ 'type' => 'object', 'properties' => [ 'timestamp' => ['title' => '时间戳（Unix秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'], 'totalAmount' => ['title' => '该时间点的总费用', 'type' => 'number', 'format' => 'float', 'example' => '1.23'], ], ], 'BillingBillSummaryRespDTO' => [ 'type' => 'object', 'properties' => [ 'totalAmount' => ['title' => '时间范围内的总费用', 'type' => 'number', 'format' => 'float', 'example' => '123.45'], 'points' => [ 'title' => '费用趋势数据点列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/BillingBillSummaryPointDTO'], ], ], ], 'BillingBillTierDTO' => [ 'type' => 'object', 'properties' => [ 'dimValues' => ['title' => '维度键值映射，key为维度列名，value为展示值', 'type' => 'string', 'example' => '{"context_tier": "0-32k"}'], 'values' => ['title' => '用量数值映射，key为指标名，value为数值', 'type' => 'string', 'example' => '{"input_tokens": 1000, "output_tokens": 500}'], 'payableAmount' => ['title' => '该桶的费用', 'type' => 'number', 'format' => 'float', 'example' => '0.05'], ], ], 'BillingCostBreakdownRespDTO' => [ 'description' => 'The cost breakdown details.', 'type' => 'object', 'properties' => [ 'granularity' => ['description' => 'Aggregation granularity: hourly or daily ', 'title' => '聚合粒度：hourly 或 daily', 'type' => 'string', 'example' => 'hourly'], 'page' => ['description' => 'Current page number ', 'title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'pageSize' => ['description' => 'Number of entries per page ', 'title' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'total' => ['description' => 'Total number of entries ', 'title' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'columns' => [ 'title' => '列定义，根据查询结果中出现的模型类型动态生成', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/MetricDefRespDTO', 'description' => '', 'title' => '', 'example' => ''], 'example' => '[]', 'description' => '', ], 'rows' => [ 'description' => 'List of billing details data ', 'title' => '计费明细数据列表', 'type' => 'array', 'items' => ['description' => 'Single billing detail entry ', '$ref' => '#/components/schemas/BillingCostBreakdownRowDTO', 'title' => '', 'example' => ''], 'example' => '[]', ], ], 'title' => '', 'example' => '', ], 'BillingCostBreakdownRowDTO' => [ 'description' => 'A billing breakdown item.', 'type' => 'object', 'properties' => [ 'summaryTime' => ['description' => 'Statistics time point, Unix timestamp (seconds) ', 'title' => '统计时间点，Unix时间戳（秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'], 'modelId' => ['description' => 'Model ID ', 'title' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelCode' => ['description' => 'Model identifier ', 'title' => '模型标识符', 'type' => 'string', 'example' => 'qwen-plus'], 'modelName' => ['description' => 'Model name ', 'title' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'], 'modelType' => ['description' => 'Statistics category ', 'title' => '统计口径', 'type' => 'string', 'example' => 'llm'], 'clientId' => ['description' => 'Department ID; 0 indicates no associated department ', 'title' => '部门ID，0表示无归属部门', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'clientName' => ['description' => 'Department name ', 'title' => '部门名称', 'type' => 'string', 'example' => '研发部'], 'apiKeyId' => ['title' => 'API Key ID，0 表示历史数据未细分到 ApiKey', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'description' => ''], 'apiKeyName' => ['title' => 'API Key 名称，对应 api_key_id', 'type' => 'string', 'example' => '默认密钥', 'description' => ''], 'billingType' => ['description' => 'Billing type; currently fixed as total_amount ', 'title' => '计费类型，当前固定为 total_amount', 'type' => 'string', 'example' => 'total_amount'], 'payableAmount' => ['description' => 'Payable amount, rounded to 8 decimal places ', 'title' => '应付金额，保留8位小数', 'type' => 'number', 'format' => 'float', 'example' => '0.00012800'], 'dimValues' => ['title' => '维度值映射，如计费版本、上下文窗口阶梯等，无维度时省略', 'type' => 'string', 'example' => '{"billing_version": "v1"}', 'description' => ''], 'values' => ['title' => '用量+费用分项数值映射，key与columns中的key对应', 'type' => 'string', 'example' => '{"input_tokens": 512000, "output_tokens": 256000}', 'description' => ''], 'tiers' => [ 'title' => '维度桶子表，按上下文分段等计费时展开，无分段时省略', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/BillingBillTierDTO', 'description' => '', 'title' => '', 'example' => ''], 'example' => '[]', 'description' => '', ], ], 'title' => '', 'example' => '', ], 'ClientBalanceDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'description' => 'The unique ID of the balance record.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'clientId' => ['title' => '部门ID', 'description' => 'The ID of the client.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'balance' => ['title' => '当前余额', 'description' => 'The current balance.', 'type' => 'number', 'format' => 'double', 'example' => '100.00'], 'balanceType' => ['title' => '余额类型：amount（金额）/ tokens（token数量）', 'description' => 'The balance type. Valid values are `amount` or `tokens`.', 'type' => 'string', 'example' => 'amount'], 'enableBalance' => ['title' => '是否启用余额限流', 'description' => 'Indicates whether balance-based rate limiting is enabled.', 'type' => 'boolean', 'example' => 'true'], 'gmtCreate' => ['title' => '创建时间', 'description' => 'The creation timestamp.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => '更新时间', 'description' => 'The last modification timestamp.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'description' => 'Contains the balance details for a client.', 'title' => '', 'example' => '', ], 'ClientBalanceLogDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => '记录ID', 'description' => 'The unique record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'clientId' => ['title' => '部门ID', 'description' => 'The client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'changeAmount' => ['title' => '变更金额（正数=充值，负数=扣费）', 'description' => 'The change amount. A positive value represents a recharge, and a negative value represents a deduction.', 'type' => 'number', 'format' => 'double', 'example' => '10.00'], 'balanceBefore' => ['title' => '变更前余额', 'description' => 'The previous balance.', 'type' => 'number', 'format' => 'double', 'example' => '90.00'], 'balanceAfter' => ['title' => '变更后余额', 'description' => 'The new balance.', 'type' => 'number', 'format' => 'double', 'example' => '100.00'], 'changeType' => ['title' => '变更类型：auto_deduct/deduct/recharge', 'description' => 'The type of change. Possible values are `auto_deduct`, `deduct`, or `recharge`.', 'type' => 'string', 'example' => 'recharge'], 'remark' => ['title' => '备注', 'description' => 'Notes about the balance change.', 'type' => 'string', 'example' => '充值'], 'gmtCreate' => ['title' => '创建时间', 'description' => 'The creation time in ISO 8601 UTC format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'description' => 'The balance log.', 'title' => '', 'example' => '', ], 'ClientCreateCmd' => [ 'type' => 'object', 'properties' => [ 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户', 'description' => ''], 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市', 'description' => ''], 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000', 'description' => ''], 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注', 'description' => ''], 'allowedModels' => ['title' => '允许的模型ID列表，逗号分隔，空表示全部', 'type' => 'string', 'example' => '1,2,3', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ClientDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户', 'description' => ''], 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市', 'description' => ''], 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000', 'description' => ''], 'main' => ['title' => '0=主账户 1=普通账户', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注', 'description' => ''], 'clientUuid' => ['title' => '客户唯一标识', 'type' => 'string', 'example' => 'st-xxxx', 'description' => ''], 'allowedModels' => ['title' => '允许的模型ID列表，逗号分隔，空表示全部', 'type' => 'string', 'example' => '1,2,3', 'description' => ''], 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ClientListQry' => [ 'type' => 'object', 'properties' => [ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'keyword' => ['title' => '搜索关键字', 'type' => 'string', 'description' => '', 'example' => ''], 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ClientTreeDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户', 'description' => ''], 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市', 'description' => ''], 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000', 'description' => ''], 'main' => ['title' => '0=主账户 1=普通账户', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注', 'description' => ''], 'clientUuid' => ['title' => '客户唯一标识', 'type' => 'string', 'example' => 'st-xxxx', 'description' => ''], 'allowedModels' => ['title' => '允许的模型ID列表，逗号分隔，空表示全部', 'type' => 'string', 'example' => '1,2,3', 'description' => ''], 'discount' => ['title' => '折扣系数，1.0=无折扣，0.8=八折', 'type' => 'number', 'format' => 'double', 'example' => '1.0', 'description' => ''], 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], 'level' => ['title' => '层级 1~5', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'parentId' => ['title' => '父部门ID，NULL=顶层', 'type' => 'integer', 'format' => 'int64', 'example' => 'null', 'description' => ''], 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'balance' => ['title' => '余额信息', 'example' => 'null', '$ref' => '#/components/schemas/ClientBalanceDTO', 'description' => ''], 'children' => [ 'title' => '子客户列表', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/ClientTreeDTO', 'description' => '', 'title' => '', 'example' => ''], 'example' => '[]', 'description' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ClientUpdateCmd' => [ 'type' => 'object', 'properties' => [ 'name' => ['title' => '客户名称', 'type' => 'string', 'example' => '我的客户', 'description' => ''], 'address' => ['title' => '公司地址', 'type' => 'string', 'example' => '杭州市', 'description' => ''], 'contact' => ['title' => '联系方式', 'type' => 'string', 'example' => '13800138000', 'description' => ''], 'remark' => ['title' => '备注信息', 'type' => 'string', 'example' => '备注', 'description' => ''], 'status' => ['title' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'allowedModels' => ['title' => '允许的模型ID列表，逗号分隔，空表示全部', 'type' => 'string', 'example' => '1,2,3', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ConversationCreateCmd' => [ 'type' => 'object', 'properties' => [ 'chatData' => ['title' => '对话数据JSON，包含各模型的消息记录（必填）', 'type' => 'string', 'description' => '', 'example' => ''], 'modelIds' => ['title' => '模型ID列表，JSON数组字符串', 'type' => 'string', 'description' => '', 'example' => ''], 'title' => ['title' => '对话标题，不传则自动从第一条用户消息提取', 'type' => 'string', 'description' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ConversationDTO' => [ 'description' => 'The data structure for a conversation.', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'description' => 'The ID of the conversation.', 'type' => 'integer', 'example' => '1', 'format' => 'int64'], 'title' => ['title' => '标题', 'description' => 'The title of the conversation.', 'type' => 'string', 'example' => '我的对话'], 'messageCount' => ['title' => '消息数量', 'description' => 'The total number of messages in the conversation.', 'type' => 'integer', 'example' => '10', 'format' => 'int32'], 'modelIds' => ['title' => '模型ID列表JSON', 'description' => 'A JSON-formatted string that contains an array of model IDs.', 'type' => 'string', 'example' => '[1,2,3]'], 'chatData' => ['title' => '完整对话状态JSON', 'description' => 'A JSON-formatted string that represents the complete state of the conversation.', 'type' => 'string', 'example' => '{}'], 'deleteTag' => ['title' => '0=启用 非0=禁用', 'description' => 'The status of the conversation, where 0 means enabled and any non-zero value means disabled.', 'type' => 'integer', 'example' => '0', 'format' => 'int32'], 'gmtCreate' => ['title' => '创建时间', 'description' => 'The creation time of the conversation, in ISO 8601 format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => '更新时间', 'description' => 'The modification time of the conversation, in ISO 8601 format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'title' => '', 'example' => '', ], 'ConversationListQry' => [ 'type' => 'object', 'properties' => [ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'keyword' => ['title' => '搜索关键字', 'type' => 'string', 'description' => '', 'example' => ''], 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ConversationUpdateCmd' => [ 'type' => 'object', 'properties' => [ 'title' => ['title' => '对话标题', 'type' => 'string', 'example' => '我的对话', 'description' => ''], 'chatData' => ['title' => '对话数据JSON，包含各模型的消息记录', 'type' => 'string', 'example' => '{"messages":[{"role":"user","content":"你好"}]}', 'description' => ''], 'messageCount' => ['title' => '消息数量', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'description' => ''], 'modelIds' => ['title' => '模型ID列表，JSON数组字符串', 'type' => 'string', 'example' => '[1,2,3]', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'CostModelDetailRespDTO' => [ 'description' => 'Contains the detailed usage data for a model.', 'type' => 'object', 'properties' => [ 'columns' => [ 'description' => 'List of column definitions ', 'title' => '列定义列表', 'type' => 'array', 'items' => ['description' => 'Column ', '$ref' => '#/components/schemas/MetricDefRespDTO', 'title' => '', 'example' => ''], 'example' => '', ], 'granularity' => ['description' => 'Current granularity: daily/hourly ', 'title' => '当前粒度：daily/hourly', 'type' => 'string', 'example' => 'hourly'], 'modelId' => ['description' => 'Model ID ', 'title' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelName' => ['description' => 'Model name ', 'title' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'], 'page' => ['description' => 'Current page ', 'title' => '当前页', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'pageSize' => ['description' => 'Number of entries per page ', 'title' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'rows' => [ 'description' => 'List of data rows ', 'title' => '数据行列表', 'type' => 'array', 'items' => ['description' => 'Row', '$ref' => '#/components/schemas/CostModelDetailRowDTO', 'title' => '', 'example' => ''], 'example' => '', ], 'total' => ['description' => 'Total number of entries ', 'title' => '总条数', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], ], 'title' => '', 'example' => '', ], 'CostModelDetailRowDTO' => [ 'description' => 'Usage detail structure ', 'type' => 'object', 'properties' => [ 'timestamp' => ['description' => 'UNIX timestamp (Unix seconds) ', 'title' => '时间戳（Unix秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'], 'values' => ['description' => 'Metric value mapping, where the key is the metric name and the value is numeric ', 'title' => '指标值映射，key为指标名，value为数值', 'type' => 'string', 'example' => '"{\\"total_calls\\":3,\\"video_duration\\":0,\\"total_amount\\":0.6,\\"image_count\\":3,\\"timestamp\\":1776787200}"'], ], 'title' => '', 'example' => '', ], 'CostQueryModelsDTO' => [ 'description' => 'The schema for the model usage table.', 'type' => 'object', 'properties' => [ 'columns' => [ 'description' => 'List of column definitions ', 'title' => '列定义列表', 'type' => 'array', 'items' => ['description' => 'Column ', '$ref' => '#/components/schemas/MetricDefRespDTO', 'title' => '', 'example' => ''], 'example' => '', ], 'idField' => ['description' => 'Field Name of ID ', 'title' => 'ID字段名', 'type' => 'string', 'example' => 'model_id'], 'nameField' => ['description' => 'Field Name of Name ', 'title' => '名称字段名', 'type' => 'string', 'example' => 'model_name'], 'rows' => [ 'description' => 'List of model data rows ', 'title' => '模型数据行列表', 'type' => 'array', 'items' => ['description' => 'Row', '$ref' => '#/components/schemas/ModelRowDTO', 'title' => '', 'example' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'CostQueryTrendDTO' => [ 'description' => 'The data structure for the cost trend.', 'type' => 'object', 'properties' => [ 'defaultMetric' => ['title' => '默认指标', 'description' => 'The default metric.', 'type' => 'string', 'example' => 'total_amount'], 'granularity' => ['title' => '粒度：hourly或daily', 'description' => 'The granularity of the data. Valid values are `hourly` and `daily`.', 'type' => 'string', 'example' => 'hourly'], 'metrics' => [ 'description' => 'A list of metric definitions.', 'title' => '指标定义列表', 'type' => 'array', 'items' => ['description' => 'A metric definition object.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/MetricDefRespDTO'], 'example' => '', ], 'points' => [ 'description' => 'A list of data points for the trend.', 'title' => '趋势数据点列表', 'type' => 'array', 'items' => ['description' => 'A data point object.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/TrendPointDTO'], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'CostTabDTO' => [ 'description' => 'Represents a cost tab.', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'Tab UUID ', 'title' => 'Tab唯一标识', 'type' => 'string', 'example' => 'all'], 'label' => ['description' => 'Tab display name ', 'title' => 'Tab显示名称', 'type' => 'string', 'example' => '全部'], 'modelTypes' => [ 'description' => 'List of associated model types ', 'title' => '关联的模型类型列表', 'type' => 'array', 'items' => ['description' => 'Model type name ', 'type' => 'string', 'example' => 'Chat', 'title' => ''], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'MetricDefRespDTO' => [ 'description' => 'metric structure', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'Metric key name ', 'title' => '指标键名', 'type' => 'string', 'example' => 'total_calls'], 'label' => ['description' => 'Metric display name ', 'title' => '指标显示名称', 'type' => 'string', 'example' => '调用次数'], 'sortable' => ['description' => 'Is sortable ', 'title' => '是否可排序', 'type' => 'boolean', 'example' => 'true'], 'unit' => ['description' => 'Metric unit ', 'title' => '指标单位', 'type' => 'string', 'example' => '次'], ], 'title' => '', 'example' => '', ], 'MetricKVPairDTO' => [ 'description' => 'Metric ', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'Metric Name. '."\n" ."\n" .'**Chat** '."\n" .'- `total_calls`: Number Of Calls, integer, Count '."\n" .'- `input_tokens`: Total input tokens, integer '."\n" .'- `output_tokens`: Total output tokens, integer '."\n" .'- `reasoning_tokens`: Reasoning tokens, integer '."\n" .'- `cached_tokens`: Cached input tokens (hit), integer '."\n" ."\n" .'**Vision** '."\n" .'- `total_calls`: Number Of Calls, integer, Count '."\n" .'- `image_count`: Number of generated images, integer '."\n" .'- `video_duration`: Generated video duration, rounded to 3 decimal places, seconds '."\n" ."\n" .'**Embedding** '."\n" .'- `total_calls`: Number Of Calls, integer, Count '."\n" .'- `embedding_output_tokens`: Embedding output tokens, integer '."\n" .'- `billing_tokens`: Total billing tokens, integer '."\n" .'- `image_tokens`: Image tokens (multimodal embedding), integer '."\n" ."\n" .'**Omni-modal (ChatFullmodal / ChatMultimodal)** '."\n" .'- `total_calls`: Number Of Calls, integer, Count '."\n" .'- `input_text_tokens`: Input text tokens, integer '."\n" .'- `input_audio_tokens`: Input audio tokens, integer '."\n" .'- `input_image_tokens`: Input image tokens, integer '."\n" .'- `input_video_tokens`: Input video tokens, integer '."\n" .'- `output_text_tokens`: Output text tokens, integer '."\n" .'- `output_audio_tokens`: Output audio tokens, integer '."\n" ."\n" .'**Speech (TTS / ASR)** '."\n" .'- `total_calls`: Number Of Calls, integer, Count '."\n" .'- `characters`: Characters converted to speech, integer '."\n" .'- `asr_duration`: Speech recognition duration, rounded to 3 decimal places, seconds ', 'title' => '指标名称', 'type' => 'string', 'example' => 'total_calls'], 'value' => ['description' => 'Metric value ', 'title' => '指标数值', 'type' => 'number', 'format' => 'float', 'example' => '100'], ], 'title' => '', 'example' => '', ], 'MetricValueDTO' => [ 'description' => 'Represents a single metric.', 'type' => 'object', 'properties' => [ 'key' => ['description' => 'Metric key name ', 'title' => '指标键名', 'type' => 'string', 'example' => 'total_calls'], 'label' => ['description' => 'Metric display name ', 'title' => '指标显示名称', 'type' => 'string', 'example' => '调用次数'], 'unit' => ['description' => 'Metric unit ', 'title' => '指标单位', 'type' => 'string', 'example' => '次'], 'value' => ['description' => 'Metric value ', 'title' => '指标值', 'type' => 'number', 'format' => 'float', 'example' => '100'], ], 'title' => '', 'example' => '', ], 'ModelCreateCmd' => [ 'type' => 'object', 'properties' => [ 'name' => ['title' => '模型名称', 'type' => 'string', 'example' => '通义千问', 'description' => ''], 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问大模型', 'description' => ''], 'symbol' => ['title' => '厂商symbol', 'type' => 'string', 'example' => 'alibaba', 'description' => ''], 'tags' => ['title' => '标签，逗号分隔', 'type' => 'string', 'example' => 'chat,NLP', 'description' => ''], 'modelId' => ['title' => '模型标识', 'type' => 'string', 'example' => 'qwen-turbo', 'description' => ''], 'modelType' => ['title' => '模型类型', 'type' => 'string', 'example' => 'Chat', 'description' => ''], 'apiKey' => ['title' => 'API Key', 'type' => 'string', 'example' => 'sk-xxxx', 'description' => ''], 'baseUrl' => ['title' => 'Base URL', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com', 'description' => ''], 'maxInputLength' => ['title' => '最大输入长度', 'type' => 'string', 'example' => '8192', 'description' => ''], 'maxOutputLength' => ['title' => '最大输出长度', 'type' => 'string', 'example' => '2048', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ModelDTO' => [ 'description' => 'Contains the details of the model.', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'description' => 'The unique ID of the model.', 'type' => 'integer', 'example' => '1', 'format' => 'int64'], 'name' => ['title' => '模型名称', 'description' => 'The model name.', 'type' => 'string', 'example' => '通义千问'], 'description' => ['title' => '模型描述', 'description' => 'The model description.', 'type' => 'string', 'example' => '通义千问大模型'], 'symbol' => ['title' => '厂商symbol', 'description' => 'The vendor symbol.', 'type' => 'string', 'example' => 'alibaba'], 'tags' => ['title' => '标签，逗号分隔', 'description' => 'A comma-separated list of model tags.', 'type' => 'string', 'example' => 'chat,NLP'], 'modelCode' => ['title' => '模型标识', 'description' => 'The model code.', 'type' => 'string', 'example' => 'qwen-turbo'], 'modelType' => ['title' => '模型类型', 'description' => 'The model type.', 'type' => 'string', 'example' => 'Chat'], 'apiKeyPreview' => ['title' => 'API密钥预览', 'description' => 'A masked preview of the API key.', 'type' => 'string', 'example' => 'sk-xxx****xxx'], 'baseUrl' => ['title' => 'Base URL', 'description' => 'The base URL for API requests.', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'], 'maxInputLength' => ['title' => '最大输入长度', 'description' => 'The maximum input length.', 'type' => 'string', 'example' => '8192'], 'maxOutputLength' => ['title' => '最大输出长度', 'description' => 'The maximum output length.', 'type' => 'string', 'example' => '2048'], 'isCustom' => ['title' => '是否为自定义', 'description' => 'Indicates whether the model is custom.', 'type' => 'boolean', 'example' => 'false'], 'tagNames' => ['title' => '标签显示名称', 'description' => 'The display names for the tags, separated by commas.', 'type' => 'string', 'example' => '对话,自然语言处理'], 'deleteTag' => ['title' => '0=启用 非0=禁用', 'description' => 'Indicates the model\'s status. A value of 0 means enabled, and a non-zero value means disabled.', 'type' => 'integer', 'example' => '0', 'format' => 'int32'], 'gmtCreate' => ['title' => '创建时间', 'description' => 'The time when the model was created, in ISO 8601 format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => '更新时间', 'description' => 'The time when the model was last updated, in ISO 8601 format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'version' => ['title' => '版本', 'description' => 'The version number.', 'type' => 'integer', 'example' => '0', 'format' => 'int32'], 'hasBillingRule' => ['title' => '是否已配置计费规则', 'type' => 'boolean', 'description' => '', 'example' => 'false'], 'inOut' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'extensions' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'ModelListQry' => [ 'type' => 'object', 'properties' => [ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'keyword' => ['title' => '搜索关键字', 'type' => 'string', 'description' => '', 'example' => ''], 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => ''], 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ModelMetricsDTO' => [ 'type' => 'object', 'properties' => [ 'totalCalls' => ['title' => '总调用量', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'description' => ''], 'successRate' => ['title' => '成功率(%)', 'type' => 'number', 'format' => 'double', 'example' => '99.5', 'description' => ''], 'avgResponseTime' => ['title' => '平均响应时间 (ms)', 'type' => 'number', 'format' => 'double', 'example' => '200.5', 'description' => ''], 'inputTokens' => ['title' => '输入 Token 总数', 'type' => 'integer', 'format' => 'int64', 'example' => '500000', 'description' => ''], 'outputTokens' => ['title' => '输出 Token 总数', 'type' => 'integer', 'format' => 'int64', 'example' => '300000', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'ModelRowDTO' => [ 'description' => 'Represents the data structure for a single model row.', 'type' => 'object', 'properties' => [ 'modelCode' => ['description' => 'Model identity ', 'title' => '模型标识', 'type' => 'string', 'example' => 'qwen-plus'], 'modelId' => ['description' => 'Model ID ', 'title' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelName' => ['description' => 'Model name ', 'title' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'], 'values' => ['description' => 'Metric value mapping, where the key is the metric name and the value is the numeric value ', 'title' => '指标值映射，key为指标名，value为数值', 'type' => 'string', 'example' => '"{\\"total_calls\\":21,\\"video_duration\\":210,\\"total_amount\\":126,\\"image_count\\":0}"'], ], 'title' => '', 'example' => '', ], 'ModelUpdateCmd' => [ 'type' => 'object', 'properties' => [ 'name' => ['title' => '模型名称', 'type' => 'string', 'example' => '通义千问'], 'description' => ['title' => '模型描述', 'type' => 'string', 'example' => '通义千问大模型'], 'status' => ['title' => '状态', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'symbol' => ['title' => '厂商symbol', 'type' => 'string', 'example' => 'alibaba'], 'tags' => ['title' => '标签，逗号分隔', 'type' => 'string', 'example' => 'chat,NLP'], 'modelId' => ['title' => '模型标识', 'type' => 'string', 'example' => 'qwen-turbo'], 'modelType' => ['title' => '模型类型', 'type' => 'string', 'example' => 'Chat'], 'apiKey' => ['title' => 'API Key', 'type' => 'string', 'example' => 'sk-xxxx'], 'baseUrl' => ['title' => 'Base URL', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'], 'maxInputLength' => ['title' => '最大输入长度', 'type' => 'string', 'example' => '8192'], 'maxOutputLength' => ['title' => '最大输出长度', 'type' => 'string', 'example' => '2048'], ], ], 'ObservationChartsDTO' => [ 'type' => 'object', 'properties' => [ 'qpm' => [ 'title' => 'QPM 时间序列', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'example' => '', ], 'tpm' => [ 'title' => 'TPM 时间序列', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'example' => '', ], 'concurrency' => [ 'title' => '并发连接数', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'example' => '', ], 'callVolume' => [ 'title' => '调用量时间序列', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'example' => '', ], 'successRate' => [ 'title' => '成功率时间序列', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'timestamp' => ['title' => '时间戳(RFC3339)', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'value' => ['title' => '值', 'type' => 'any', 'description' => '', 'example' => ''], 'label' => ['title' => '标签', 'type' => 'string', 'example' => 'series1', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'description' => '', 'example' => '', ], 'responseTime' => [ 'title' => '响应时间时间序列', 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/TimeSeriesPointDTO', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'ObservationLogListQry' => [ 'type' => 'object', 'properties' => [ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'clientId' => ['title' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'apiKeyId' => ['title' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelId' => ['title' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'timeRange' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'example' => '24h'], 'startTime' => ['title' => '自定义开始时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'endTime' => ['title' => '自定义结束时间', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z'], ], ], 'ObservationQry' => [ 'type' => 'object', 'properties' => [ 'clientId' => ['title' => '客户ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'apiKeyId' => ['title' => 'API Key ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelId' => ['title' => '模型ID筛选', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'timeRange' => ['title' => '时间范围 (1h, 6h, 24h, 7d, 30d)', 'type' => 'string', 'example' => '24h'], 'startTime' => ['title' => '自定义开始时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'endTime' => ['title' => '自定义结束时间', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z'], ], ], 'OralEvaluationStatisticsCallsCountRequest' => [ 'description' => 'Request body object for invocation statistics ', 'type' => 'object', 'properties' => [ 'projectId' => ['title' => '项目id', 'description' => 'project ID ', 'type' => 'string', 'example' => '123'], 'startTime' => ['title' => '起始时间', 'description' => 'Start Time ', 'type' => 'string', 'example' => '2024-10-14 07:40:01'], 'endTime' => ['title' => '截止时间', 'description' => 'End Time ', 'type' => 'string', 'example' => '2024-10-15 07:40:01'."\n"], 'granularity' => ['title' => '查询颗粒度（小时、天，月）', 'description' => 'Query granularity (hour, Day, month) ', 'type' => 'string', 'example' => 'DAY'], 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'example' => 'a0007g7'], ], 'title' => '', 'example' => '', ], 'OralEvaluationStatisticsCallsCountResponse' => [ 'title' => '调用量统计响应体对象', 'description' => 'The response body for call volume statistics.', 'type' => 'object', 'properties' => [ 'projectId' => ['title' => '项目id', 'description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '123'], 'projectData' => [ 'title' => '项目统计数据', 'description' => 'The project statistics.', 'type' => 'object', 'properties' => [ 'applicationInternalId' => ['title' => '应用内部id', 'description' => 'The internal application ID.', 'type' => 'string', 'required' => true, 'example' => '11'], 'ApplicationData' => [ 'title' => '应用数据对象列表', 'description' => 'A list of application data objects.', 'type' => 'array', 'items' => [ 'description' => 'An application data object.', 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['title' => 'appkey', 'description' => 'The appkey.', 'type' => 'string', 'required' => true, 'example' => 'a0007g7'], 'Data' => [ 'title' => '统计项列表', 'description' => 'A list of data objects.', 'type' => 'array', 'items' => [ 'description' => 'A data object.', 'type' => 'object', 'properties' => [ 'name' => ['title' => '统计项名称', 'description' => 'The name of the statistic.', 'type' => 'string', 'required' => true, 'example' => '2025-01'], 'count' => ['title' => '统计项数量', 'description' => 'The corresponding count.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '2'], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'required' => true, 'example' => '', ], ], 'example' => '', ], 'OralEvaluationStatisticsConcurrentCountRequest' => [ 'description' => 'Request body object for concurrency statistics ', 'type' => 'object', 'properties' => [ 'projectId' => ['title' => '项目id', 'description' => 'project ID ', 'type' => 'string', 'example' => '123'], 'startTime' => ['title' => '起始时间', 'description' => 'Start Time ', 'type' => 'string', 'example' => '2024-09-29 05:00:01'], 'endTime' => ['title' => '截止时间', 'description' => 'End Time ', 'type' => 'string', 'example' => '2024-09-29 14:22:48'], 'granularity' => ['title' => '查询颗粒度（小时、天，月）', 'description' => 'Query granularity (hour, Day, month) ', 'type' => 'string', 'example' => 'DAY'], 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'example' => 'a0007g7'], ], 'title' => '', 'example' => '', ], 'OralEvaluationStatisticsConcurrentCountResponse' => [ 'title' => '并发数统计响应体', 'description' => 'Contains concurrent count statistics.', 'type' => 'object', 'properties' => [ 'projectId' => ['title' => '项目id', 'description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '123'], 'projectData' => [ 'title' => '项目统计数据', 'description' => 'Statistical data for the project.', 'type' => 'object', 'properties' => [ 'applicationInternalId' => ['title' => '应用内部id', 'description' => 'The internal application ID.', 'type' => 'string', 'required' => true, 'example' => '11'], 'ApplicationData' => [ 'title' => '应用数据对象列表', 'description' => 'A list of application data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['title' => 'appkey', 'description' => 'The app key.', 'type' => 'string', 'required' => true, 'example' => 'a0007g7'], 'Data' => [ 'title' => '统计项列表', 'description' => 'A list of data nodes.', 'type' => 'array', 'items' => [ 'description' => 'A data node.', 'type' => 'object', 'properties' => [ 'name' => ['title' => '统计项名称', 'description' => 'The name of the statistical item.', 'type' => 'string', 'required' => true, 'example' => '2025-01'], 'count' => ['title' => '统计项数量', 'description' => 'The count of the item.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], ], 'required' => true, 'example' => '', ], ], 'example' => '', ], 'OralEvaluationStatisticsErrorCountRequest' => [ 'description' => 'Request body object for oral evaluation error codes ', 'type' => 'object', 'properties' => [ 'projectId' => ['title' => '项目id', 'description' => 'Project ID ', 'type' => 'string', 'example' => '123'], 'startTime' => ['title' => '起始时间', 'description' => 'Start time ', 'type' => 'string', 'example' => '2024-09-27 09:32:00'], 'endTime' => ['title' => '截止时间', 'description' => 'End time ', 'type' => 'string', 'example' => '2024-08-22 06:24:53'], 'granularity' => ['title' => '查询颗粒度（小时、天，月）', 'description' => 'Query granularity (Hour, Day, Month) ', 'type' => 'string', 'example' => 'DAY'], 'errorCode' => [ 'title' => '错误码', 'description' => 'List of error codes ', 'type' => 'array', 'items' => ['description' => 'Error code. ', 'type' => 'string', 'example' => '51000', 'title' => ''], 'example' => '', ], 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'appId,appkey', 'type' => 'string', 'example' => 'a0007g7'], ], 'title' => '', 'example' => '', ], 'OralEvaluationStatisticsErrorCountResponse' => [ 'description' => 'The response object for error code statistics.', 'type' => 'object', 'properties' => [ 'projectId' => ['title' => '项目id', 'description' => 'The project ID.', 'type' => 'string', 'required' => true, 'example' => '123'], 'ProjectData' => [ 'description' => 'Contains the statistical data aggregated by project.', 'type' => 'object', 'properties' => [ 'applicationInternalId' => ['title' => '应用内部id', 'description' => 'The internal ID of the application.', 'type' => 'string', 'required' => true, 'example' => '1'], 'ApplicationData' => [ 'description' => 'A list of statistical data objects for the application.', 'type' => 'array', 'items' => [ 'description' => 'A statistical data object for the application.', 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['title' => 'appId,appkey', 'description' => 'The App ID or App Key.', 'type' => 'string', 'required' => true, 'example' => 't000797'], 'Data' => [ 'description' => 'A list of datasets.', 'type' => 'array', 'items' => [ 'description' => 'A dataset object.', 'type' => 'object', 'properties' => [ 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '51000', 'title' => ''], 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'start the core unsuccessfull.', 'title' => ''], 'Data' => [ 'description' => 'A list of statistical items.', 'type' => 'array', 'items' => [ 'description' => 'A statistical item.', 'type' => 'object', 'properties' => [ 'name' => ['title' => '统计项名称,展示颗粒度', 'description' => 'The name of the statistical item, which defines the display granularity.', 'type' => 'string', 'required' => true, 'example' => '2025-02'], 'count' => ['title' => '统计项数量', 'description' => 'The count for the statistical item.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '230'], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'OrgInitResultDTO' => [ 'type' => 'object', 'properties' => [ 'orgId' => ['title' => '企业ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'userId' => ['title' => '用户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'clientUuid' => ['title' => '客户唯一标识', 'type' => 'string', 'example' => 'st-xxxx', 'description' => ''], 'apiKey' => ['title' => '返回明文 API Key，仅初始化时可见一次', 'type' => 'string', 'example' => 'sk-xxxxxxxxxxxxxx', 'description' => ''], 'isNew' => ['title' => '是否为新创建（false 表示已存在）', 'type' => 'boolean', 'example' => 'true', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'PaidResourceDTO' => [ 'description' => 'The data for a paid resource.', 'type' => 'object', 'properties' => [ 'instanceId' => ['title' => '实例Id', 'description' => 'The ID of the instance.', 'type' => 'string', 'example' => 'airec-cn-fou41hse8001'], 'resourcePackageCode' => ['title' => '资源包编码', 'description' => 'The code of the resource package.', 'type' => 'string', 'example' => 'PRE_PAID_RECOURSE_PACKAGE'], 'resourcePackageName' => ['title' => '资源包名称', 'description' => 'The name of the resource package.', 'type' => 'string', 'example' => '智能批改-资源包'], 'resourceCatalogCode' => ['title' => '资源类型', 'description' => 'The code of the resource type.', 'type' => 'string', 'example' => 'AI_ORAL'], 'resourceCatalogName' => ['title' => '资源类型名称', 'description' => 'The name of the resource type.', 'type' => 'string', 'example' => '口语评测'], 'resourceStatus' => [ 'title' => '资源状态', 'description' => 'The status of the resource.', 'enumValueTitles' => ['ALL' => '所有', 'ACTIVE' => '有效', 'INVALID' => '无效'], 'type' => 'string', 'example' => 'ACTIVE', ], 'quantity' => ['title' => '总量', 'description' => 'The total quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], 'remainQuantity' => ['title' => '余量', 'description' => 'The remaining quantity.', 'type' => 'integer', 'format' => 'int32', 'example' => '1000'], 'effectiveTime' => ['title' => '生效时间', 'description' => 'The time the resource becomes effective.', 'type' => 'string', 'example' => '2025-09-01 00:00:00'], 'expireTime' => ['title' => '失效时间', 'description' => 'The time the resource expires.', 'type' => 'string', 'example' => '2025-09-10 00:00:00'], ], 'title' => '', 'example' => '', ], 'RequestLogDTO' => [ 'type' => 'object', 'properties' => [ 'id' => ['title' => 'ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'requestId' => ['title' => '请求ID', 'type' => 'string', 'example' => 'req-xxxx', 'description' => ''], 'clientId' => ['title' => '客户ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'apiKeyId' => ['title' => 'API Key ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'modelId' => ['title' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => ''], 'modelName' => ['title' => '模型名称', 'type' => 'string', 'example' => '通义千问', 'description' => ''], 'requestTime' => ['title' => '请求时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'responseTimeMs' => ['title' => '响应时间(ms)', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => ''], 'statusCode' => ['title' => '状态码', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'description' => ''], 'promptTokens' => ['title' => '输入Token', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'description' => ''], 'completionTokens' => ['title' => '输出Token', 'type' => 'integer', 'format' => 'int32', 'example' => '50', 'description' => ''], 'totalTokens' => ['title' => '总Token', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'description' => ''], 'requestBody' => ['title' => '请求体', 'type' => 'string', 'example' => '{}', 'description' => ''], 'responseBody' => ['title' => '响应体', 'type' => 'string', 'example' => '{}', 'description' => ''], 'deleteTag' => ['title' => '0=启用 非0=禁用', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => ''], 'gmtCreate' => ['title' => '创建时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'gmtModified' => ['title' => '更新时间', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'modelCode' => ['title' => '模型', 'type' => 'string', 'example' => 'qwen3-max', 'description' => ''], 'symbol' => ['title' => '标记', 'type' => 'string', 'example' => 'qwen', 'description' => ''], 'clientUuid' => ['title' => 'client的唯一标识', 'type' => 'string', 'example' => 'mt_xxxxxMYTX9', 'description' => ''], 'status' => ['title' => '状态', 'type' => 'string', 'example' => 'success', 'description' => ''], 'modelType' => ['title' => '模型类型', 'type' => 'string', 'example' => 'Chat', 'description' => ''], 'usage' => ['title' => '使用量统计', 'example' => '{"prompt_tokens":100,"completion_tokens":50,"total_tokens":150}', '$ref' => '#/components/schemas/UsageInfoDTO', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'RequestLogListQry' => [ 'type' => 'object', 'properties' => [ 'page' => ['title' => '页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'keyword' => ['title' => '搜索关键字', 'type' => 'string'], 'status' => ['title' => '状态筛选', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'pageSize' => ['title' => '每页数量', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], 'TimeSeriesPointDTO' => [ 'type' => 'object', 'properties' => [ 'timestamp' => ['title' => '时间戳(RFC3339)', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'description' => ''], 'value' => ['title' => '值', 'type' => 'any', 'description' => '', 'example' => ''], 'label' => ['title' => '标签', 'type' => 'string', 'example' => 'series1', 'description' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'TrendPointDTO' => [ 'description' => 'Trend point structure ', 'type' => 'object', 'properties' => [ 'timestamp' => ['description' => 'UNIX timestamp (Unix seconds) ', 'title' => '时间戳（Unix秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'], 'values' => ['description' => 'Metric value mapping, where the key is the metric name and the value is the numeric value ', 'title' => '指标值映射，key为指标名，value为数值', 'type' => 'string', 'example' => '"{\\"total_calls\\":0,\\"video_duration\\":0,\\"total_amount\\":0,\\"model_count\\":0,\\"image_count\\":0}"'], ], 'title' => '', 'example' => '', ], 'UsageBreakdownRespDTO' => [ 'description' => 'The data structure for the usage breakdown.', 'type' => 'object', 'properties' => [ 'granularity' => ['description' => 'Aggregation granularity: hourly or daily ', 'title' => '聚合粒度：hourly 或 daily', 'type' => 'string', 'example' => 'hourly'], 'page' => ['description' => 'Current page number ', 'title' => '当前页码', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'pageSize' => ['description' => 'Number of entries per page ', 'title' => '每页条数', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'total' => ['description' => 'Total number of entries ', 'title' => '总条数', 'type' => 'integer', 'format' => 'int64', 'example' => '100'], 'rows' => [ 'description' => 'List of detailed data entries ', 'title' => '明细数据列表', 'type' => 'array', 'items' => ['description' => 'Single entry of usage details ', '$ref' => '#/components/schemas/UsageBreakdownRowDTO', 'title' => '', 'example' => ''], 'example' => '[]', ], ], 'title' => '', 'example' => '', ], 'UsageBreakdownRowDTO' => [ 'description' => 'A single usage record.', 'type' => 'object', 'properties' => [ 'summaryTime' => ['description' => 'Statistics time point, Unix timestamp (seconds) ', 'title' => '统计时间点，Unix时间戳（秒）', 'type' => 'integer', 'format' => 'int64', 'example' => '1700000000'], 'modelId' => ['description' => 'Model ID ', 'title' => '模型ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelCode' => ['description' => 'Model identifier ', 'title' => '模型标识符', 'type' => 'string', 'example' => 'qwen-plus'], 'modelName' => ['description' => 'Model name ', 'title' => '模型名称', 'type' => 'string', 'example' => '通义千问-Plus'], 'modelType' => ['description' => 'Statistics scope ', 'title' => '统计口径', 'type' => 'string', 'example' => 'llm'], 'clientId' => ['description' => 'Department ID; 0 indicates no associated department ', 'title' => '部门ID，0表示无归属部门', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'clientName' => ['description' => 'Department name ', 'title' => '部门名称', 'type' => 'string', 'example' => '研发部'], 'apiKeyId' => ['title' => 'API Key ID，0 表示历史数据未细分到 ApiKey', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'description' => ''], 'apiKeyName' => ['title' => 'API Key 名称，对应 api_key_id', 'type' => 'string', 'example' => '默认密钥', 'description' => ''], 'metrics' => [ 'description' => 'Array of usage metrics, containing only entries with non-zero values ', 'title' => '用量指标数组，仅包含值不为0的条目', 'type' => 'array', 'items' => ['description' => 'Metric ', '$ref' => '#/components/schemas/MetricKVPairDTO', 'title' => '', 'example' => ''], 'example' => '[{"key": "total_calls", "value": 100}]', ], ], 'title' => '', 'example' => '', ], 'UsageInfoDTO' => [ 'type' => 'object', 'properties' => [ 'promptTokens' => ['title' => '输入Token', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'completionTokens' => ['title' => '输出Token', 'type' => 'integer', 'format' => 'int32', 'example' => '50'], 'totalTokens' => ['title' => '总Token', 'type' => 'integer', 'format' => 'int32', 'example' => '150'], 'imageCount' => ['title' => '图片数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'videoCount' => ['title' => '视频数量', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'videoDuration' => ['title' => '视频时长(秒)', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], ], ], ], ], 'apis' => [ 'AITeacherExpansionPracticeTaskGenerate' => [ 'summary' => 'Generate Q&A pairs to expand data.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '6440xxxxxxxxxx5fafc98c421', 'title' => ''], 'grade' => [ 'description' => 'The grade.', 'enumValueTitles' => [3 => 'Primary School Grade 3', 'Primary School Grade 4', 'Primary School Grade 5', 'Primary School Grade 6', 'Middle School Grade 7', 'Middle School Grade 8', 'Middle School Grade 9', 'High School Grade 10', 'High School Grade 11', 'High School Grade 12', 'University'], 'type' => 'string', 'required' => true, 'example' => '13', 'title' => '', ], 'textbook' => ['description' => 'The name of the textbook.', 'type' => 'string', 'required' => false, 'example' => '英语（基础模块）修订版', 'title' => ''], 'topic' => ['description' => 'The conversation topic.', 'type' => 'string', 'required' => true, 'example' => 'talk about your dream job.', 'title' => ''], 'learningObject' => ['description' => 'The learning object to guide task generation.', '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.', 'title' => ''], 'textContent' => [ 'description' => 'The reference article used to generate questions.', 'enumValueTitles' => [], '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.', 'title' => '', ], 'keySentences' => [ 'description' => 'A list of key sentences from the `textContent` to focus on during task generation.', 'type' => 'array', 'items' => ['description' => 'A key sentence.', '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.', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'keyWords' => [ 'description' => 'A list of keywords from the `textContent` to focus on during task generation.', 'type' => 'array', 'items' => ['description' => 'A keyword.', 'type' => 'string', 'required' => false, 'example' => 'responsibility', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['description' => 'Indicates if the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'taskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'textbook_dialogue', 'title' => ''], 'taskContent' => [ 'description' => 'A list of Q\\&A pairs.', 'type' => 'array', 'items' => [ 'description' => 'A Q\\&A pair.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The AI teacher\'s question.', 'type' => 'string', 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'user' => ['description' => 'The student\'s answer.', 'type' => 'string', 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'backgroundDescription' => ['description' => 'The background of the conversation.', '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.', 'title' => ''], 'startSentence' => ['description' => 'The opening sentence of the conversation.', 'type' => 'string', 'example' => 'Hey Jamie, do you know what a travel blogger does?', 'title' => ''], 'roleSet' => [ 'description' => 'The role settings.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The name of the AI teacher.', 'type' => 'string', 'example' => 'Alex', 'title' => ''], 'user' => ['description' => 'The name of the student.', 'type' => 'string', 'example' => 'Jamie', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"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' => 'Generate extended practice dialogue tasks ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExpansionPracticeTaskGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AITeacherSyncPracticeTaskGenerate' => [ 'summary' => 'Synchronous basic practice is primarily for dialogue tasks with a ground truth. Although this mode allows some deviation from the ground truth, the AI strictly requires users to follow it.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '6440xxxxxxxxxx5fafc98c421'."\n", 'title' => ''], 'grade' => [ 'description' => 'The grade.', 'enumValueTitles' => [3 => 'Grade 3', 'Grade 4', 'Grade 5', 'Grade 6', 'Grade 7', 'Grade 8', 'Grade 9', 'Grade 10', 'Grade 11', 'Grade 12', 'University'], 'type' => 'string', 'required' => true, 'example' => '13'."\n", 'title' => '', ], 'textbook' => ['description' => 'The textbook.', 'type' => 'string', 'required' => false, 'example' => '英语（基础模块）修订版'."\n", 'title' => ''], 'topic' => ['description' => 'The dialogue topic.', 'type' => 'string', 'required' => true, 'example' => 'talk about your dream job.'."\n", 'title' => ''], 'learningObject' => ['description' => 'The learning objective.', '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", 'title' => ''], 'textContent' => ['description' => 'The source text for generating questions.', '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.', 'title' => ''], 'keySentences' => [ 'description' => 'A list of key sentences.', 'type' => 'array', 'items' => ['description' => 'A key sentence.', '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.', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], 'keyWords' => [ 'description' => 'A list of keywords.', 'type' => 'array', 'items' => ['description' => 'A keyword.', 'type' => 'string', 'required' => false, 'example' => 'responsibility'."\n", 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID, used for troubleshooting.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'."\n"], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'."\n", 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'."\n", 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object that contains the generated content.', 'type' => 'object', 'properties' => [ 'taskType' => ['description' => 'The task type.', 'type' => 'string', 'example' => 'textbook_question_answering', 'title' => ''], 'taskContent' => [ 'description' => 'An array of Q\\&A pairs representing the dialogue task.', 'type' => 'array', 'items' => [ 'description' => 'A single Q\\&A pair containing an assistant question and a user answer.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The AI assistant\'s question.', 'type' => 'string', 'example' => 'Why might some people think dog walking is a great job?'."\n", 'title' => ''], 'user' => ['description' => 'The expected user answer to the assistant\'s question.', 'type' => 'string', 'example' => 'They think it\'s great because they won\'t be stuck in an office.'."\n", 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], ], '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' => 'Generate Synchronization Exercise Dialog Task ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:SyncPracticeTasksGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList' => [ 'summary' => 'Lists the services available on the Alibaba Cloud Console.', 'path' => '/api/v1/aliyunconsole/queryAliyunConsoleServcieList', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiMultiResponse', 'description' => 'The response object.', '$ref' => '#/components/schemas/OpenApiMultiResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the request succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message code', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The data returned.', 'title' => 'Data object', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'ServiceCode' => ['title' => 'Service code', 'description' => 'The service code.', 'type' => 'string', 'example' => 'online_ai_algorithm_personalized_text_to_image_call_count'], 'ServiceName' => ['title' => 'Service Name', 'description' => 'The service name.', 'type' => 'string', 'example' => 'AI算法模型-个性化文生图-在线按量调用'], 'FreeCount' => ['title' => 'Trial usage', 'description' => 'The free trial calls.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'FreeConcurrencyCount' => ['title' => 'Trial concurrency', 'description' => 'The free trial concurrency.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'title' => '', 'example' => '', ], 'example' => '[]', ], ], 'example' => '{'."\n" .' "data":['."\n" .' {'."\n" .' "freeConcurrencyCount":1,'."\n" .' "serviceCode":"online_oral_evaluation_call_count",'."\n" .' "serviceName":"口语评测-在线预付费按量调用",'."\n" .' "freeCount":500'."\n" .' },'."\n" .' {'."\n" .' "freeConcurrencyCount":1,'."\n" .' "serviceCode":"online_ai_algorithm_conversation_call_count",'."\n" .' "serviceName":"AI算法模型-人机对话-在线按量调用",'."\n" .' "freeCount":500'."\n" .' }'."\n" .' ],'."\n" .' "success":true,'."\n" .' "requestId":"592A27EF-26D3-1434-98C1-97AD63337852",'."\n" .' "notEmpty":true,'."\n" .' "empty":false'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"ServiceCode\\": \\"online_ai_algorithm_personalized_text_to_image_call_count\\",\\n \\"ServiceName\\": \\"AI算法模型-个性化文生图-在线按量调用\\",\\n \\"FreeCount\\": 100,\\n \\"FreeConcurrencyCount\\": 10\\n }\\n ]\\n}","type":"json"}]', 'title' => 'List of Open Service Capabilities', 'changeSet' => [ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServcieList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList' => [ 'summary' => 'Lists the services available in the Alibaba Cloud console.', 'path' => '/api/v1/aliyunConsole/queryAliyunConsoleServiceList', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'list'], 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiMultiResponse', 'description' => 'OpenApiMultiResponse\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'An array of service objects.', 'type' => 'array', 'items' => [ 'description' => 'A service object in the data array.', 'type' => 'object', 'properties' => [ 'ServiceCode' => ['description' => 'The service code.', 'type' => 'string'], 'ServiceName' => ['description' => 'The service name.', 'type' => 'string'], 'FreeCount' => ['description' => 'The free quota.', 'type' => 'integer'], 'FreeConcurrencyCount' => ['description' => 'The free concurrency count.', 'type' => 'integer'], ], '$ref' => '#/components/schemas/AliyunConsoleServiceInfoDTO', 'title' => '', 'example' => '', ], 'example' => '[]', ], ], 'example' => '{'."\n" .' "data":['."\n" .' {'."\n" .' "freeConcurrencyCount":1,'."\n" .' "serviceCode":"online_oral_evaluation_call_count",'."\n" .' "serviceName":"口语评测-在线预付费按量调用",'."\n" .' "freeCount":500'."\n" .' },'."\n" .' {'."\n" .' "freeConcurrencyCount":1,'."\n" .' "serviceCode":"online_ai_algorithm_conversation_call_count",'."\n" .' "serviceName":"AI算法模型-人机对话-在线按量调用",'."\n" .' "freeCount":500'."\n" .' }'."\n" .' ],'."\n" .' "success":true,'."\n" .' "requestId":"592A27EF-26D3-1434-98C1-97AD63337852",'."\n" .' "notEmpty":true,'."\n" .' "empty":false'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"ServiceCode\\": \\"\\",\\n \\"ServiceName\\": \\"\\",\\n \\"FreeCount\\": 0,\\n \\"FreeConcurrencyCount\\": 0\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Service List Query', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServiceList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'AliyunConsoleOpenApiQueryPaidResource' => [ 'summary' => 'Alibaba Cloud Management Console / List purchased resources ', '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', 'description' => 'OpenApiPageResponse', 'type' => 'object', 'properties' => [ 'totalCount' => ['title' => '', 'description' => 'Total quantity ', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'pageSize' => ['title' => '', 'description' => 'Number of items per page ', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], 'pageIndex' => ['title' => '', 'description' => 'Page index ', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'requestId' => ['title' => '', 'description' => 'Request ID ', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the request succeeded ', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => '', 'description' => 'Error message encoding ', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => '', 'description' => 'error message ', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => '', 'description' => 'HTTP status code ', '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' => 'Data object ', 'type' => 'array', 'items' => ['description' => 'Data object ', 'example' => '[]', '$ref' => '#/components/schemas/PaidResourceDTO', 'title' => ''], 'example' => '[]', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], '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\\": \\"airec-cn-fou41hse8001\\",\\n \\"resourcePackageCode\\": \\"PRE_PAID_RECOURSE_PACKAGE\\",\\n \\"resourcePackageName\\": \\"智能批改-资源包\\",\\n \\"resourceCatalogCode\\": \\"AI_ORAL\\",\\n \\"resourceCatalogName\\": \\"口语评测\\",\\n \\"resourceStatus\\": \\"ACTIVE\\",\\n \\"quantity\\": 10000,\\n \\"remainQuantity\\": 1000,\\n \\"effectiveTime\\": \\"2025-09-01 00:00:00\\",\\n \\"expireTime\\": \\"2025-09-10 00:00:00\\"\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Purchased resources ', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:AliyunConsoleOpenApiQueryPaidResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [], ], ], 'CountOralEvaluationStatisticsCalls' => [ 'summary' => 'Intelligent Correction / Oral Evaluation / Statistics / call volume', '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' => 'The request body.', '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountRequest', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiMultiResponse', 'description' => 'OpenApiMultiResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'array', 'items' => ['description' => 'An object in the data array.', '$ref' => '#/components/schemas/OralEvaluationStatisticsCallsCountResponse', 'title' => '', 'example' => ''], '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 {\\n \\"projectId\\": \\"123\\",\\n \\"projectData\\": {\\n \\"applicationInternalId\\": \\"11\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"a0007g7\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"2025-01\\",\\n \\"count\\": 2\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Query Oral Evaluation Service Invocation Usage ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:countOralEvaluationStatisticsCalls', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CountOralEvaluationStatisticsConcurrent' => [ 'summary' => 'Intelligent grading / oral evaluation / statistics / concurrency', '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' => 'The request body.', '$ref' => '#/components/schemas/OralEvaluationStatisticsConcurrentCountRequest', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiMultiResponse', 'description' => 'OpenApiMultiResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'array', 'items' => ['description' => 'The returned data.', '$ref' => '#/components/schemas/OralEvaluationStatisticsConcurrentCountResponse', 'title' => '', 'example' => ''], '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 {\\n \\"projectId\\": \\"123\\",\\n \\"projectData\\": {\\n \\"applicationInternalId\\": \\"11\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"a0007g7\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"2025-01\\",\\n \\"count\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Concurrent Count Statistics for Oral Evaluation Service', 'changeSet' => [], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:countOralEvaluationStatisticsConcurrent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'flowControl' => [ 'flowControlList' => [], ], ], 'CountOralEvaluationStatisticsError' => [ 'summary' => 'Retrieves statistics about API call errors for the oral evaluation service.', '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' => 'The request body for retrieving error statistics for the oral evaluation service.', '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountRequest', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiMultiResponse', 'description' => 'The top-level object in the response.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => '`true` if the request succeeded; `false` otherwise.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails. This parameter is returned only when `success` is `false`.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails. This parameter is returned only when `success` is `false`.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'An array containing the error statistics.', 'type' => 'array', 'items' => ['description' => 'An object that contains error statistics for the oral evaluation service.', '$ref' => '#/components/schemas/OralEvaluationStatisticsErrorCountResponse', 'title' => '', 'example' => ''], 'example' => '[]', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"projectId\\": \\"123\\",\\n \\"ProjectData\\": {\\n \\"applicationInternalId\\": \\"1\\",\\n \\"ApplicationData\\": [\\n {\\n \\"applicationAccessId\\": \\"t000797\\",\\n \\"Data\\": [\\n {\\n \\"ErrorCode\\": \\"51000\\",\\n \\"ErrorMessage\\": \\"start the core unsuccessfull.\\",\\n \\"Data\\": [\\n {\\n \\"name\\": \\"2025-02\\",\\n \\"count\\": 230\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Statistics of Error Codes for Oral Evaluation Service', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:countOralEvaluationStatisticsError', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateAccessWarrant' => [ 'summary' => 'Creates an access warrant.', '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' => ['description' => 'The merchant\'s application ID.', 'type' => 'string', 'example' => 'a123', 'title' => '', 'required' => false], 'timestamp' => ['description' => 'The 10-digit request timestamp in seconds.', 'type' => 'string', 'example' => '1701000000', 'title' => '', 'required' => false], 'userId' => ['description' => 'The merchant\'s user ID.', 'type' => 'string', 'example' => 'sn123', 'title' => '', 'required' => false], 'userClientIp' => ['description' => 'The public IP address of the client device.', 'type' => 'string', 'example' => '110.25.23.12', 'title' => '', 'required' => false], 'requestSign' => ['description' => 'The signature for the request parameters.', 'type' => 'string', 'example' => 'e32fac43df0b0b0be32fac43df0b0b0b', 'title' => '', 'required' => false], 'warrantAvailable' => ['description' => 'The duration, in seconds, for which the access warrant is valid.', 'type' => 'integer', 'format' => 'int32', 'example' => '7200', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SingleResponse', 'description' => 'SingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The unique request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'ApplicationAccessId' => ['description' => 'The merchant\'s application ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'UserId' => ['description' => 'The merchant\'s user ID.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'AccessToken' => ['description' => 'The access token.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'AccessWarrantId' => ['description' => 'The access warrant ID.', 'type' => 'string', 'example' => 'ex2xxxxxxxx', 'title' => ''], 'ExpireTime' => ['description' => 'The expiration time of the access warrant.', 'type' => 'string', 'example' => '1672531200', 'title' => ''], 'CreateTime' => ['description' => 'The creation time of the access warrant.', 'type' => 'string', 'example' => '1672531200', 'title' => ''], ], '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' => '创建授权信息', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:CreateAccessWarrant', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'CreateProject' => [ 'summary' => 'Alibaba Cloud console > Create Project', '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' => ['description' => 'Project name', 'type' => 'string', 'example' => 'MyProject', 'title' => '', 'required' => false], 'projectType' => ['description' => 'Project type', 'type' => 'string', 'example' => 'online_oral_evaluation_post_paid_call_count', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SingleResponse', 'description' => 'SingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '124187'], 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'MyProject', 'title' => ''], 'ProjectType' => ['description' => 'The project type.', 'type' => 'string', 'example' => 'WebApplication', 'title' => ''], 'ProjectApps' => [ 'title' => '', 'description' => 'The applications in the project.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The internal ID of the application.', 'type' => 'string', 'title' => '', 'example' => '4867'], 'ApplicationAccessIds' => [ 'title' => '', 'description' => 'The access credentials for the application.', 'type' => 'array', 'items' => [ 'description' => 'An object containing an app key and app secret.', 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['description' => 'The app key.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'applicationAccessSecret' => ['description' => 'The app secret. This parameter is returned only for requests sent from the console.', 'type' => 'string', 'example' => 'MyAppSecret', 'title' => ''], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '4910'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectSDK' => [ 'title' => '', 'description' => 'The SDKs for the project.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SdkName' => ['description' => 'The name of the SDK.', 'type' => 'string', 'title' => '', 'example' => 'C SDK'], 'DeployMode' => ['description' => 'The deployment mode. Valid values: client or server.', 'type' => 'string', 'title' => '', 'example' => '客户端'], 'DevelopLanguage' => ['description' => 'The development language.', 'type' => 'string', 'title' => '', 'example' => 'C++'], 'SdkUrl' => ['description' => 'The SDK\'s download URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/sdk.zip'], 'DocUrl' => ['description' => 'The SDK\'s documentation URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/doc'], 'DemoUrl' => ['description' => 'The demo\'s URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/demo'], 'SdkVersion' => ['description' => 'The SDK version.', 'type' => 'string', 'title' => '', 'example' => '4.12.8'], 'CreateTime' => ['description' => 'The SDK\'s creation time.', 'type' => 'string', 'title' => '', 'example' => '2023-02-15T09:17:39Z'."\n"], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The project\'s creation time.', 'type' => 'string', 'title' => '', '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' => 'Create Project ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:CreateProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun' => [ 'summary' => 'Executes a workflow for Chinese composition tutoring.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'essayOutline' => ['description' => 'The essay outline.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '题目： 春天的色彩'."\n" .'开头： 开门见山，点明主题。'."\n" .'中间： 分段描写春天的不同色彩。'."\n" .'结尾： 总结全文，抒发情感。'], 'essayRequirements' => ['description' => 'The essay requirements.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '生动形象，字数不得少于100字'], 'essayTopic' => ['description' => 'The essay topic.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '春天的景色'], 'essayType' => [ 'description' => 'The essay type.'."\n" ."\n" .'outline: An outline.'."\n" ."\n" .'essay: A full essay.', 'type' => 'string', 'required' => true, 'enum' => ['essay', 'outline'], 'title' => '', 'example' => 'essay', ], 'essayWordCount' => ['description' => 'The target word count.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100'], 'grade' => ['description' => 'The student\'s grade level.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '3'."\n"], 'responseMode' => [ 'description' => 'The response mode.', 'type' => 'string', 'required' => true, 'enum' => ['streaming'], 'title' => '', 'example' => 'streaming', ], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'xxxxxxxxx'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique ID for the request. This ID is useful for troubleshooting.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'event' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'message', 'title' => ''], 'content' => ['description' => 'The content associated with the event.', 'type' => 'string', 'example' => '春天里常见的景', 'title' => ''], ], 'example' => '', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'errMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'httpStatusCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"春天里常见的景\\"\\n}","type":"json"}]', 'title' => 'Chinese Composition Tutoring', 'requestParamsDescription' => 'System parameters are not required in the request.', 'responseParamsDescription' => 'Example of a streaming response:'."\n" ."\n" .'data:{"event":"start"}'."\n" ."\n" .'data:{"event":"message","content":"###"}'."\n" ."\n" .'data:{"event":"message","content":" "}'."\n" ."\n" .'data:{"event":"message","content":"Essay"}'."\n" ."\n" .'data:{"event":"message","content":" analysis \\n- \\*\\*"}'."\n" ."\n" .'data:{"event":"message","content":"Common spring scenery"}'."\n" ."\n" .'data:{"event":"message","content":" and the feelings of love for it."}'."\n" ."\n" .'data:{"event":"end"}', 'changeSet' => [ ['createdAt' => '2025-04-23T03:18:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherChineseCompositionTutoringWorkflowRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun' => [ 'summary' => 'English Composition Tutoring', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'essayOutline' => [ 'description' => 'The essay outline.', 'type' => 'string', 'enum' => [], 'title' => '', 'required' => false, 'example' => 'Title: The Importance of Reading'."\n" .'I. Introduction'."\n" .'II. Body'."\n" .'III. Conclusion', ], 'essayRequirements' => ['description' => 'The essay requirements.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'No less than 100 words'], 'essayTopic' => ['description' => 'The essay topic.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Discuss what to eat'], 'essayType' => [ 'description' => 'The essay type. Valid values:'."\n" ."\n" .'`outline`: an outline'."\n" ."\n" .'essay: essay', 'type' => 'string', 'required' => true, 'enum' => ['essay', 'outline'], 'title' => '', 'example' => 'essay', ], 'essayWordCount' => ['description' => 'The required word count.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '100'], 'grade' => ['description' => 'The student\'s grade level.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '3'], 'responseMode' => [ 'description' => 'The response mode. For example, set this value to `streaming` to receive server-sent events.', 'type' => 'string', 'required' => true, 'default' => 'streaming', 'enum' => ['streaming'], 'title' => '', 'example' => 'streaming', ], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'xxxxxxx'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'event' => ['description' => 'The event type.', 'type' => 'string', 'example' => 'message', 'title' => ''], 'content' => ['description' => 'The content of the event.', 'type' => 'string', 'example' => 'hi', 'title' => ''], ], 'example' => '', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'httpStatusCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"hi\\"\\n}","type":"json"}]', 'title' => 'English composition generation ', 'changeSet' => [ ['createdAt' => '2025-04-23T03:18:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherEnglishCompositionTutoringWorkflowRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherEnglishParaphraseChatMessage' => [ 'summary' => 'Answers English-related questions.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'questionInfo' => ['description' => 'The user\'s question.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'How to inquire about the price'], 'grade' => ['description' => 'The grade level.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '3'], 'userAnswer' => ['description' => 'The user\'s answer to the question.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'How much is this?'], 'questionId' => ['description' => 'A unique identifier for the question.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'xxxxxxxxx'], 'content' => ['description' => 'The user\'s chat message.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'How much is this?'], 'chatId' => ['description' => 'The unique ID for the chat session.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '6788e0b475a4631ffc626722'], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'xxxxxxx'], 'responseMode' => ['description' => 'The response mode. Set this to `streaming` to receive the response as a stream of events.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'sreaming'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'event' => ['title' => 'Id of the request', 'description' => 'The event type.', 'type' => 'string', 'example' => 'message'], 'content' => ['description' => 'The content associated with the event.', 'type' => 'string', 'example' => 'how', 'title' => ''], 'requestId' => ['description' => 'The request ID. This ID is returned with every response and is useful for troubleshooting.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], ], 'example' => '', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errMsg' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'httpStatusCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"event\\": \\"message\\",\\n \\"content\\": \\"how\\",\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\"\\n}","type":"json"}]', 'title' => 'English Q&A', 'changeSet' => [ ['createdAt' => '2025-04-23T03:18:41.000Z', 'description' => 'Request parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherEnglishParaphraseChatMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherExpansionDialogue' => [ 'summary' => 'Expansion dialogues are for open-ended conversations. In these conversations, the AI poses open-ended questions, but the user must stay on topic. If a user\'s response is off-topic, the AI steers the conversation back on topic. If the user gives two consecutive off-topic responses, the AI moves on to the next topic.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'A list of dialogue records.', 'type' => 'array', 'items' => [ 'description' => 'A single dialogue record.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => [ 'description' => 'The role of the message author.', 'enumValueTitles' => ['assistant' => 'The AI assistant.', 'user' => 'The user.'], 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => '', ], 'isOnTopic' => ['description' => 'Indicates whether the user\'s response is on topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'Indicates whether the user\'s response is off-topic. This parameter controls the dialogue flow. For example, if the user provides two consecutive off-topic responses, set this value to `true` to advance to the next dialogue task.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The order of the message in the dialogue.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'A list of dialogue tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The message content from the assistant.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translated content of the assistant\'s message.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The user\'s message content.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The order of the task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => true, 'description' => '', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'languageCode' => [ 'description' => 'The language code for the conversation.', 'enumValueTitles' => ['en-us' => 'American English', 'en-gb' => 'British English'], 'type' => 'string', 'example' => 'en-gb', 'title' => '', 'required' => false, ], 'background' => ['description' => 'The background of the dialogue.', '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.', 'title' => ''], 'roleInfo' => [ 'title' => '', 'description' => 'Specifies the names of the participants in the dialogue.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The name of the AI assistant.', 'type' => 'string', 'required' => true, 'example' => 'Alex', 'title' => ''], 'user' => ['description' => 'The name of the user.', 'type' => 'string', 'required' => true, 'example' => 'Jamie', 'title' => ''], ], 'required' => true, 'example' => '', ], 'topic' => ['description' => 'The topic of the conversation.', 'type' => 'string', 'required' => true, 'example' => 'Let\'s talk about traffic rules.', 'title' => ''], 'startSentence' => ['description' => 'The opening sentence of the dialogue.', 'type' => 'string', 'example' => 'Hello Lily, could you please come to the kitchen for a moment?', 'title' => '', 'required' => false], 'userId' => ['description' => 'The unique identifier for the user.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The AI teacher\'s response in English.', 'type' => 'string', 'example' => '1', 'title' => ''], 'chineseResult' => ['description' => 'The AI teacher\'s response in Chinese.', 'type' => 'string', 'example' => '1', 'title' => ''], 'isFinish' => ['description' => 'Indicates whether the dialogue is finished.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'isOffTopicControl' => ['description' => 'Indicates whether the response is off-topic.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'isOnTopic' => ['description' => 'Indicates whether the response is on-topic.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'questionIndex' => ['description' => 'The index of the current question.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], '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\\": \\"1\\",\\n \\"chineseResult\\": \\"1\\",\\n \\"isFinish\\": true,\\n \\"isOffTopicControl\\": true,\\n \\"isOnTopic\\": true,\\n \\"questionIndex\\": 2\\n }\\n}","type":"json"}]', 'title' => 'Execute extended practice ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:AITeacherExecuteExpansionPractice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherExpansionDialogueRefine' => [ 'summary' => 'Uses context to polish the expanded text.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'A list of dialogue records.', 'type' => 'array', 'items' => [ 'description' => 'An object that represents a dialogue record.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The content of the dialogue turn.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => [ 'description' => 'The role of the speaker in the dialogue turn.', 'enumValueTitles' => ['assistant' => 'The AI assistant.', 'user' => 'The user.'], 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => '', ], 'isOnTopic' => ['description' => 'Indicates whether the user\'s response is on-topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'Manages the off-topic conversation flow. This flag is forcibly set to `true` to switch the dialogue task if the conversation has gone off-topic more than twice.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The sequence number of the dialogue turn.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'A collection of dialogue tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The AI\'s dialogue content.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translated content of the AI\'s dialogue.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The user\'s dialogue content.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The sequence number of the dialogue task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'description' => 'An object that represents a dialogue task.', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'background' => ['description' => 'The background of the conversation.', 'type' => 'string', 'required' => true, 'title' => '', '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' => 'The role settings for the conversation.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The name or persona of the AI assistant.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Jane, a caring mother'], 'user' => ['description' => 'The name or persona of the user.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Lily, a friendly student'], ], 'required' => true, 'example' => '', ], 'topic' => ['description' => 'The main topic of the conversation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'talk about your dream job.'], 'languageCode' => [ 'description' => 'The language code for the dialogue.', 'enumValueTitles' => ['en-us' => 'American English', 'en-gb' => 'British English'], 'type' => 'string', 'required' => false, 'example' => 'en-gb', 'title' => '', ], 'startSentence' => ['description' => 'The opening sentence of the dialogue.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Hello Lily, could you please come to the kitchen for a moment?'], 'userId' => ['description' => 'The unique identifier for the user.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code. Returned only when the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message. Returned only when the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The object that contains the refinement result.', 'type' => 'object', 'properties' => [ 'result' => ['description' => 'The refinement result.', 'type' => 'string', 'example' => 'Yes, I\'ll be right there.', 'title' => ''], ], '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\\": \\"Yes, I\'ll be right there.\\"\\n }\\n}","type":"json"}]', 'title' => 'Execute refinement for extended practice', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueRefine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherExpansionDialogueTranslate' => [ 'summary' => 'Further Contextual Translation Practice.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'An array of dialogue records.', 'type' => 'array', 'items' => [ 'description' => 'A single dialogue record.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The dialogue content.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => ['description' => 'The role of the message author. Valid values are `assistant` for the AI and `user` for the user.', 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => ''], 'isOnTopic' => ['description' => 'Indicates whether the message is on-topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'Controls the conversation flow based on whether the user\'s response is off-topic. This value is determined by previous turns. If a user provides more than two consecutive off-topic responses, the system sets this parameter to `true` to switch tasks.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The sequence number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'An array of dialogue tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The dialogue content from the assistant.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translation of the assistant content.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The dialogue content from the user.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The sequence number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'description' => 'A single dialogue task.', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'background' => ['description' => 'The background context for the dialogue.', 'type' => 'string', 'required' => true, 'title' => '', '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' => 'Role information for the participants.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The assistant name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Jane, a caring mother'], 'user' => ['description' => 'The user name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Lily, a friendly student'], ], 'required' => true, 'example' => '', ], 'topic' => ['description' => 'The topic of the conversation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'talk about food.'], 'startSentence' => ['description' => 'The opening sentence of the dialogue.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'Hello Lily, could you please come to the kitchen for a moment?'], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'result' => ['description' => 'The translation result.', 'type' => 'string', 'example' => '太好了，谢谢你过来，莉莉。你喜欢吃肉吗？', 'title' => ''], ], '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' => 'Execute extended practice translation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueTranslate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherGrammarCheck' => [ 'summary' => 'Performs a grammar check.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The sentence to check.', 'type' => 'string', 'required' => true, 'example' => 'i is good', 'title' => ''], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object that contains the result.', 'type' => 'object', 'properties' => [ 'correctionStatus' => ['description' => 'The result of the grammar check.', 'type' => 'string', 'example' => 'Has_Error', 'title' => ''], 'errorReason' => ['description' => 'The error reason.', 'type' => 'string', 'title' => '', 'example' => '暂无返回'], 'correction' => ['description' => 'The corrected sentence.', 'type' => 'string', 'example' => 'I am good.', 'title' => ''], 'analysis' => ['description' => 'The error analysis.', 'type' => 'string', 'example' => '主语 "I" 对应的动词应该是 "am" 而不是 "is"。', 'title' => ''], ], '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 \\"correctionStatus\\": \\"Has_Error\\",\\n \\"errorReason\\": \\"暂无返回\\",\\n \\"correction\\": \\"I am good.\\",\\n \\"analysis\\": \\"主语 \\\\\\"I\\\\\\" 对应的动词应该是 \\\\\\"am\\\\\\" 而不是 \\\\\\"is\\\\\\"。\\"\\n }\\n}","type":"json"}]', 'title' => 'Execute syntax detection ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherGrammarCheck', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherSyncDialogue' => [ 'summary' => 'Practice synchronous dialogue.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'An array of dialogue record objects.', 'type' => 'array', 'items' => [ 'description' => 'A dialogue record object.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => [ 'description' => 'The role of the message author.', 'enumValueTitles' => ['assistant' => 'The assistant.', 'user' => 'The user.'], 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => '', ], 'isOnTopic' => ['description' => 'Indicates whether the response is on-topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'Indicates whether the user\'s response is off-topic, acting as a flow control mechanism. This value is based on how the user\'s previous response aligned with the dialogue task. If the user goes off-topic more than twice, the system sets this parameter to `true` to trigger a task switch.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The sequence number of the message.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'An array of dialogue task objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The assistant\'s dialogue content.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translation of the assistant\'s dialogue content.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The user\'s dialogue content.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The sequence number of the task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => true, 'description' => 'A dialogue task object.', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'languageCode' => [ 'description' => 'The language and dialect of the dialogue.', 'enumValueTitles' => ['en-us' => 'American English', 'en-gb' => 'British English'], 'type' => 'string', 'example' => 'en-gb', 'title' => '', 'required' => false, ], 'userId' => ['description' => 'A unique identifier for the user.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'The API response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The English response from the AI teacher.', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?', 'title' => ''], 'isFinish' => ['description' => 'Indicates whether the dialogue is finished.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'isOnTopic' => ['description' => 'Indicates whether the user\'s response is on topic.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'questionIndex' => ['description' => 'The index of the current question.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], ], '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 \\"isFinish\\": true,\\n \\"isOnTopic\\": true,\\n \\"questionIndex\\": 2\\n }\\n}","type":"json"}]', 'title' => 'Execute synchronization job ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherSyncDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteAITeacherSyncDialogueTranslate' => [ 'summary' => 'You can practice contextual translation in real-time.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'An array of dialogue record objects.', 'type' => 'array', 'items' => [ 'description' => 'A single dialogue record.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The content of the message.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => ['description' => 'The message author\'s role.', 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => ''], 'isOnTopic' => ['description' => 'Indicates whether the message is on-topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'Indicates whether the message is off-topic. This parameter is used for flow control.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The sequence number of the message.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => true, 'title' => '', 'example' => '', ], 'required' => false, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'An array of dialogue task objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The content of the assistant\'s message.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translated content of the assistant\'s message.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The content of the user\'s message.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The sequence number of the task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'description' => 'A single dialogue task.', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'userId' => ['description' => 'The user ID.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'result' => ['description' => 'The translation result.', 'type' => 'string', 'example' => '太好了，谢谢你过来，莉莉。你喜欢吃肉吗？', 'title' => ''], ], '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' => 'Execute synchronization exercise translation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherSyncDialogueTranslate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantDialogue' => [ 'summary' => 'Executes a dialogue turn with the Textbook Assistant.', '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' => [ 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'The scenario. Valid values: SYNC for synchronous practice and EXPAND for extended practice.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'chatId' => ['description' => 'The chat ID for this turn.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'userMessage' => ['description' => 'The user\'s message content.', 'type' => 'string', 'required' => true, 'example' => 'Hello', 'title' => ''], 'authToken' => ['description' => 'The authorization token required to call the API. To get this token, use the Textbook Assistant authorization API.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], ], 'required' => false, 'description' => 'The request body.', 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'DBFA232A-1176-50E6-95AE-50F7A62A28AD'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'data' => [ 'type' => 'object', 'properties' => [ 'chatId' => ['description' => 'The chat ID for this turn.', 'type' => 'string', 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'assistant' => ['description' => 'The ID of the Textbook Assistant\'s message.', 'type' => 'string', 'example' => '6788f4935bdfc807f077a984', 'title' => ''], 'user' => ['description' => 'The ID of the user\'s reply.', 'type' => 'string', 'example' => '6788f4905bdfc807f077a982', 'title' => ''], 'result' => [ 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The Textbook Assistant\'s reply in English.', 'type' => 'string', 'example' => 'Let\'s look at the text again. Mike says, \\"I\'m Mike Black.\\" Can you try saying it like Mike?', 'title' => ''], 'chineseResult' => ['description' => 'The Textbook Assistant\'s reply in Chinese.', 'type' => 'string', 'example' => '让我们再看一遍课文。迈克说: “我是迈克·布莱克。”你能试着像迈克那样说吗？', 'title' => ''], 'isTaskCompleted' => ['description' => 'Indicates whether the task is completed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'isFinish' => ['description' => 'Indicates whether the dialogue is finished.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], ], 'description' => 'The returned data.', 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Chat with the AI teacher', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantDifficulty' => [ 'summary' => 'Adjusts the difficulty of the textbook assistant\'s dialogue.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'The interaction scenario. Specify `SYNC` for a Sync exercise or `EXPAND` for an Expansion exercise.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'chatId' => ['description' => 'The ID of the current dialogue.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'assistant' => ['description' => 'The ID of the message generated by the AI assistant.', 'type' => 'string', 'required' => true, 'example' => '6788f4a6b54c5268c1b78a25', 'title' => ''], 'authToken' => ['description' => 'The authorization token for the API call. Obtain this token by calling the relevant authorization API.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], 'action' => [ 'description' => 'The type of difficulty adjustment.', 'type' => 'string', 'required' => true, 'enum' => ['UP', 'DOWN'], 'example' => 'UP', 'title' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body for a successful request.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => '0D7D382F-9475-572E-BE83-DDFBF5C5EB24'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data returned on a successful request.', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'A container for the result data.', 'type' => 'object', 'properties' => [ 'result' => ['description' => 'The dialogue content after the difficulty adjustment.', 'type' => 'string', 'example' => 'Let\'s look at the text again. Mike says, \\"I\'m Mike Black.\\" Can you try saying it like Mike?', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Adjust the difficulty of the AI teacher\'s response content ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantDifficulty', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantGrammarCheck' => [ 'summary' => 'Performs a grammar check.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'The use case. Valid values: `SYNC` for synchronous practice and `EXPAND` for expansion practice.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'chatId' => ['description' => 'The ID of the current conversation.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'user' => ['description' => 'The message ID of the user\'s reply.', 'type' => 'string', 'required' => true, 'example' => '6788e0b45bdfc807f077a5a1', 'title' => ''], 'authToken' => ['description' => 'The authorization token for the API call. Obtain this token by calling the "Authorization token for the Textbook-style AI English Teacher" API.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1e96d17091734639835114e12c8'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'The result data.', 'type' => 'object', 'properties' => [ 'correction' => ['description' => 'The corrected sentence.', 'type' => 'string', 'example' => 'I am you.', 'title' => ''], 'analysis' => ['description' => 'The error analysis.', 'type' => 'string', 'example' => '主语 \\"I\\" 后应跟动词 \\"am\\" 而不是 \\"are\\"。', 'title' => ''], 'correctionStatus' => ['description' => 'The grammar check result. Valid values: `Has_Error` (an error was found), `No_Error` (no errors were found), and `Invalid_Sentence` (the sentence could not be parsed).', 'type' => 'string', 'example' => 'Has_Error', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Obtain the result of syntax detection for user reply content ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantGrammarCheck', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantRefineByContext' => [ 'summary' => 'Refines a sentence based on the conversational context.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'Specifies the scenario. Valid values are `SYNC` for synchronous practice and `EXPAND` for expansion practice.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'chatId' => ['description' => 'The conversation ID for the current turn.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'user' => ['description' => 'The ID of the user\'s message.', 'type' => 'string', 'required' => true, 'example' => '6788e0b45bdfc807f077a5a1', 'title' => ''], 'authToken' => ['description' => 'The authorization token for the API call. You can obtain this token by calling the authorization API for the "English Textbook AI Teacher" feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => '6F73C114-A76E-51AD-99E3-BC7B941B69E0'], 'success' => ['description' => 'A value of `true` indicates that the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'integer', 'format' => 'int32', 'example' => 'null', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'The result data.', 'type' => 'object', 'properties' => [ 'result' => ['description' => 'The refined sentence.', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Obtain the result of the polished user reply message content ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantRefineByContext', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantRetryConversation' => [ 'summary' => 'This operation retries a conversation.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'Specifies the scenario. Valid values: `SYNC` for synchronized practice and `EXPAND` for expansion practice.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'chatId' => ['description' => 'The conversation ID.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'assistant' => ['description' => 'The AI assistant\'s message ID.', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638', 'title' => ''], 'authToken' => ['description' => 'The authorization token. You can obtain this token from the API that provides authorization for the textbook AI assistant feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response body.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2F2ABF4B-A4F6-5EC7-B287-7EF5B156F1ED'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'chatId' => ['description' => 'The conversation ID.', 'type' => 'string', 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'assistant' => ['description' => 'The ID of the AI assistant\'s reply.', 'type' => 'string', 'example' => '6788e0b4b54c5268c1b78638', 'title' => ''], 'user' => ['description' => 'The ID of the user\'s reply.', 'type' => 'string', 'example' => '6788e0b45bdfc807f077a5a1', 'title' => ''], 'result' => [ 'description' => 'Contains the result data.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The AI assistant\'s reply in English.', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?', 'title' => ''], 'chineseResult' => ['description' => 'The Chinese translation of the AI assistant\'s reply.', 'type' => 'string', 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Regenerate the AI teacher\'s question content', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantRetryConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantSseDialogue' => [ 'summary' => 'Starts a conversation and returns a streaming output.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'The scenario. Set the value to SYNC for Synchronous Practice or EXPAND for Expansion Practice.', 'type' => 'string', 'required' => true, 'example' => 'EXPAND', 'enum' => ['SYNC', 'EXPAND'], 'title' => '', ], 'chatId' => ['description' => 'The ID of the current conversation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '67e374acb54c526c95c4fbd4'], 'userMessage' => ['description' => 'The content of the user\'s message.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'hello'], 'authToken' => ['description' => 'The authorization token for the API call. Obtain this token from the authorization API for the AI teacher feature.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Include this ID when you contact support for troubleshooting.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'chatId' => ['description' => 'The ID of the current conversation.', 'type' => 'string', 'title' => '', 'example' => '67e374acb54c526c95c4fbd4'], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The English response from the AI teacher.', 'type' => 'string', 'title' => '', 'example' => 'Thanks, Lily. Do you like meat, Lily?'], 'isFinish' => ['description' => 'Indicates if the conversation is finished.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], 'example' => '', ], 'assistant' => ['description' => 'The message ID generated by the AI teacher.', 'type' => 'string', 'title' => '', 'example' => '67e4c9d95bdfc83cd742ae7c'], 'user' => ['description' => 'The ID of the user\'s message.', 'type' => 'string', 'title' => '', 'example' => '67e4c9d6b54c526c95c53925'], 'success' => ['description' => 'Indicates whether the call was successful:'."\n" ."\n" .'- **true**: Success'."\n" ."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'BIZ_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '执行对话流式输出服务错误，请重试:资源信息不存在', 'title' => ''], ], 'example' => '', ], ], 401 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'errMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'requestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'AccessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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 Teacher Conversation – Streaming Output', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'none', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantSseDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantStartConversation' => [ 'summary' => 'Starts a conversation with the AI teacher. The teacher then sends the initial message.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'authToken' => ['description' => 'The authorization token for the API call. Obtain this token by calling the operation that provides the authorization token for the textbook-style AI teacher feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], 'scenario' => [ 'description' => 'The practice scenario. Valid values:'."\n" ."\n" .'`SYNC`: synchronous practice'."\n" ."\n" .'`EXPAND`: expansion practice', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'articleId' => ['description' => 'How you obtain this ID depends on the value of `scenario`.'."\n" ."\n" .'**When the `scenario` input parameter is `SYNC`:**'."\n" ."\n" .'1. From the `Get Article List` response, use the top-level `articleId` field.'."\n" ."\n" .'2. From the `Get Article Details` response, use the top-level `articleId` field.'."\n" ."\n" .'**When the `scenario` input parameter is `EXPAND`:**'."\n" ."\n" .'1. From the `Get Article Details` response, use the `sceneid` field from an element in the `sceneList` array.', 'type' => 'string', 'required' => true, 'example' => '0c05700d4d9411efbe6e0c42a106bb02', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The data returned when the request is successful.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6F73C114-A76E-51AD-99E3-BC7B941B69E0'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'B_USER_NOT_FOUND_EXCEPTION'."\n", 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '用户不存在', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'chatId' => ['description' => 'The conversation ID.', 'type' => 'string', 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'assistant' => ['description' => 'The ID of the message generated by the AI teacher.', 'type' => 'string', 'example' => '6788e0b4b54c5268c1b78638', 'title' => ''], 'user' => ['description' => 'The ID of the message generated by the user.', 'type' => 'string', 'example' => '6788e0b45bdfc807f077a5a1', 'title' => ''], 'result' => [ 'description' => 'An object that contains the response from the AI teacher.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The AI teacher\'s response in English.', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?', 'title' => ''], 'chineseResult' => ['description' => 'The AI teacher\'s response in Chinese.', 'type' => 'string', 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Start a conversation with the AI teacher ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantStartConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantSuggestion' => [ 'summary' => 'Generates a suggested response from the textbook-based AI teacher.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'chatId' => ['description' => 'The unique identifier for the current chat.', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638', 'title' => ''], 'assistant' => ['description' => 'The unique identifier for the AI teacher\'s message.', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638', 'title' => ''], 'scenario' => [ 'description' => 'The practice scenario. Valid values are `SYNC` for synchronous practice and `EXPAND` for extended practice.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'authToken' => ['description' => 'The authorization token for the API call. To obtain this token, call the operation that generates authorization tokens for the AI teacher feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0D7D382F-9475-572E-BE83-DDFBF5C5EB24', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'httpstatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'The result data.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The response from the AI teacher in English.', 'type' => 'string', 'example' => 'Good evening! From the book, how does Mike Black introduce himself?', 'title' => ''], 'chineseResult' => ['description' => 'The response from the AI teacher in Chinese.', 'type' => 'string', 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'RequesId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Obtain suggested reply content for questions asked by the AI teacher in a conversation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantSuggestion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ExecuteTextbookAssistantTranslate' => [ 'summary' => 'Translates the content of a message.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'The practice scenario. Valid values: SYNC for synchronous practice and EXPAND for extended practice.', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'chatId' => ['description' => 'The conversation ID.', 'type' => 'string', 'required' => true, 'example' => '6788e0b475a4631ffc626722', 'title' => ''], 'assistant' => ['description' => 'The ID of the assistant\'s message.', 'type' => 'string', 'required' => true, 'example' => '6788e0b4b54c5268c1b78638', 'title' => ''], 'authToken' => ['description' => 'The authorization token. Obtain this token by calling the authorization operation for the AI Textbook Assistant feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9EB79C1E-36C2-5777-BED6-C23A98DF0637', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '""', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data returned by the API.', 'type' => 'object', 'properties' => [ 'result' => [ 'description' => 'The result object.', 'type' => 'object', 'properties' => [ 'result' => ['description' => 'The translated text.', 'type' => 'string', 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Retrieve the translation result of a conversation message', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantTranslate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetAITeacherExpansionDialogueSuggestion' => [ 'summary' => 'Supplemental Practice Assistant', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'An array of dialogue records.', 'type' => 'array', 'items' => [ 'description' => 'A single dialogue record.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The content of the dialogue message.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => [ 'description' => 'The role of the message author. Valid values:', 'enumValueTitles' => ['assistant' => 'The AI assistant.', 'user' => 'The user.'], 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => '', ], 'isOnTopic' => ['description' => 'Indicates if the response is on topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'Indicates if the user\'s response has gone off-topic. This parameter controls the conversation flow based on dialogue history. The system sets this parameter to `true` to switch tasks if the user goes off-topic more than twice.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The sequence number of the message in the conversation.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'An array of objects that define the dialogue tasks.', 'type' => 'array', 'items' => [ 'description' => 'A single dialogue task.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The content of the assistant\'s dialogue.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translated content of the assistant\'s dialogue.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The content of the user\'s dialogue.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The sequence number of the task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'languageCode' => [ 'description' => 'The language code, specified as a BCP 47 language tag. Valid values:', 'enumValueTitles' => ['en-us' => 'American English', 'en-gb' => 'British English'], 'type' => 'string', 'example' => 'en-gb', 'title' => '', 'required' => false, ], 'background' => ['description' => 'The background of the conversation.', '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.', 'title' => ''], 'roleInfo' => [ 'title' => '', 'description' => 'Contains information about the roles in the conversation.', 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The name of the AI assistant.', 'type' => 'string', 'required' => true, 'example' => 'Alex', 'title' => ''], 'user' => ['description' => 'The name of the user.', 'type' => 'string', 'required' => true, 'example' => 'Jamie', 'title' => ''], ], 'required' => true, 'example' => '', ], 'topic' => ['description' => 'The main topic of the conversation.', 'type' => 'string', 'required' => true, 'example' => 'Let\'s talk about traffic rules.', 'title' => ''], 'startSentence' => ['description' => 'The opening sentence of the conversation.', 'type' => 'string', 'example' => 'Hello Lily, could you please come to the kitchen for a moment?', 'title' => '', 'required' => false], 'userId' => ['description' => 'A unique identifier for the end user, used for monitoring and abuse detection.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'A container for the returned data.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The suggested response in English.', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?', 'title' => ''], 'chineseResult' => ['description' => 'The Chinese translation of the suggested response.', 'type' => 'string', 'example' => '谢谢莉莉.你喜欢吃肉吗，莉莉？', 'title' => ''], ], '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' => 'Obtain suggestions from the Extended Practice Assistant', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:GetAITeacherExpansionDialogueSuggestion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetAITeacherSyncDialogueSuggestion' => [ 'summary' => 'Sync Practice Assistant', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'records' => [ 'title' => '', 'description' => 'A list of dialogue records.', 'type' => 'array', 'items' => [ 'description' => 'A dialogue record object.', 'type' => 'object', 'properties' => [ 'content' => ['description' => 'The message content.', 'type' => 'string', 'required' => true, 'example' => 'Ask Mark if he has thought about what his dream job might be.', 'title' => ''], 'role' => ['description' => 'The role of the message author. Valid values: `assistant` (for AI-generated messages) and `user` (for user-provided messages).', 'type' => 'string', 'required' => true, 'example' => 'AI：assistant；用户：user', 'title' => ''], 'isOnTopic' => ['description' => 'Specifies if the message is on topic. `true` indicates the message is on topic; `false` indicates it is off topic.', 'type' => 'boolean', 'example' => '扣题：true, 不扣题：false', 'title' => '', 'required' => false], 'isOffTopicControl' => ['description' => 'A control flag that indicates if a student\'s response is off-topic. The value is based on the previous turn. If the conversation goes off-topic more than twice, the system sets this value to `true` to force a task switch.', 'type' => 'boolean', 'example' => '跑题：true, 不跑题：false', 'title' => '', 'required' => false], 'order' => ['description' => 'The sequence number of the message in the conversation.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'dialogueTasks' => [ 'title' => '', 'description' => 'A list of dialogue tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'assistant' => ['description' => 'The assistant\'s message content.', 'type' => 'string', 'required' => true, 'example' => 'Why might some people think dog walking is a great job?', 'title' => ''], 'assistantTranslate' => ['description' => 'The translation of the assistant\'s message.', 'type' => 'string', 'example' => '为什么有些人认为遛狗是份好差事?', 'title' => '', 'required' => false], 'user' => ['description' => 'The user\'s message content.', 'type' => 'string', 'required' => true, 'example' => 'They think it\'s great because they won\'t be stuck in an office.', 'title' => ''], 'order' => ['description' => 'The sequence number of the dialogue task.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], 'required' => false, 'description' => 'A dialogue task object.', 'title' => '', 'example' => '', ], 'required' => true, 'example' => '', ], 'languageCode' => [ 'description' => 'The language code.', 'enumValueTitles' => ['en-us' => 'American English', 'en-gb' => 'British English'], 'type' => 'string', 'example' => 'en-gb', 'title' => '', 'required' => false, ], 'userId' => ['description' => 'The unique identifier for the end-user.', 'type' => 'string', 'required' => true, 'example' => '886eba3702xxxxxxxxx4ba52a87a525', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'A unique identifier for the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The object that contains the result of the request.', 'type' => 'object', 'properties' => [ 'englishResult' => ['description' => 'The assistant\'s suggestion in English.', 'type' => 'string', 'example' => 'Thanks, Lily. Do you like meat, Lily?', 'title' => ''], 'chineseResult' => ['title' => 'Chinese suggestion from the assistant', 'description' => 'The assistant\'s suggestion in Chinese.', 'type' => 'string', 'example' => '谢谢莉莉.你喜欢吃肉吗，莉莉？'], ], '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' => 'Obtain synchronization practice assistant suggestions', 'changeSet' => [ ['createdAt' => '2024-12-30T02:53:35.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:GetAITeacherSyncDialogueSuggestion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'GetTextbookAssistantToken' => [ 'summary' => 'Obtains an authorization token to make API calls.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'deviceId' => ['description' => 'The device ID.', 'type' => 'string', 'required' => true, 'example' => '700d4d9411efbe6e0', 'title' => ''], 'model' => ['description' => 'The device model.', 'type' => 'string', 'required' => true, 'example' => '25032PS56C', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0A5E9849-A2F0-551D-A7D8-1A8118557BAB'], 'success' => ['description' => 'Indicates whether the API call succeeded.'."\n" ."\n" .'- **true**: The API call succeeded.'."\n" ."\n" .'- **false**: The API call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'expire' => ['description' => 'The expiration time of the authorization token, in seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '5400', 'title' => ''], 'authToken' => ['description' => 'The authorization token. Use this token to make API calls to the English textbook-style AI teacher service.', 'type' => 'string', 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3', 'title' => ''], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Obtain an authorization code for using the English textbook-style AI teacher feature', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:GetTextbookAssistantToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTextbookAssistantArticleDetails' => [ 'summary' => 'Batch get article details', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'authToken' => ['description' => 'The authorization token obtained from the "Get Authorization Token for the English Textbook-Style AI Teacher" API.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], 'articleIdList' => [ 'description' => 'A list of article IDs to retrieve.', 'type' => 'array', 'items' => ['description' => 'The article ID.', 'type' => 'string', 'required' => false, 'example' => '0c05700d4d9411efbe6e0c42a106bb02', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['description' => 'Indicates if the API call succeeded.'."\n" ."\n" .'- **true**: Success'."\n" ."\n" .'- **false**: Failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'An array of article detail objects.', 'type' => 'array', 'items' => [ 'description' => 'An article detail object.', 'type' => 'object', 'properties' => [ 'articleId' => ['description' => 'The article ID.', 'type' => 'string', 'example' => '0c05700d4d9411efbe6e0c42a106bb02', 'title' => ''], 'target' => ['description' => 'The learning objectives.', 'type' => 'string', 'example' => '1.能够在自我介绍时运用句型“What\'s your name? My name is/I‘m...”进行询问及回答。\\n2.能够和新朋友运用句型“Nice to meet you(too).”进行问候。', 'title' => ''], 'questionList' => [ 'description' => 'A list of Q\\&A objects.', 'type' => 'array', 'items' => [ 'description' => 'A Q\\&A object.', 'type' => 'object', 'properties' => [ 'question' => ['description' => 'The question.', 'type' => 'string', 'example' => 'From the book, how does Mike Black introduce himself?', 'title' => ''], 'questionTranslate' => ['description' => 'The translated question.', 'type' => 'string', 'example' => '根据文章，迈克·布莱克是如何介绍自己的？', 'title' => ''], 'answer' => ['description' => 'The answer.', 'type' => 'string', 'example' => 'I\'m Mike Black', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'sceneList' => [ 'description' => 'A list of scene objects.', 'type' => 'array', 'items' => [ 'description' => 'A scene object.', 'type' => 'object', 'properties' => [ 'sceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '38cddd70509911efbe6e0c42a106bb02', 'title' => ''], 'scene' => ['description' => 'The scene description.', 'type' => 'string', 'example' => 'In the park, you introduce yourself to John and ask his name.', 'title' => ''], 'sceneImageList' => [ 'description' => 'A list of image URLs for the scene.', 'type' => 'array', 'items' => ['description' => 'An image URL.', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png', 'title' => ''], 'title' => '', 'example' => '', ], 'sceneTranslate' => ['description' => 'The translated scene description.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'theme' => [ 'description' => 'The theme object.', 'type' => 'object', 'properties' => [ 'themeName' => ['description' => 'The theme name.', 'type' => 'string', 'example' => '自我认知与提升', 'title' => ''], 'themeTranslate' => ['description' => 'The translated theme name.', 'type' => 'string', 'example' => 'Self-awareness, self-management, self-improvement', 'title' => ''], 'themeImageList' => [ 'description' => 'A list of image URLs for the theme.', 'type' => 'array', 'items' => ['description' => 'An image URL.', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'topic' => [ 'description' => 'The topic object.', 'type' => 'object', 'properties' => [ 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => '打招呼与自我介绍', 'title' => ''], 'topicTranslate' => ['description' => 'The translated topic name.', 'type' => 'string', 'example' => 'Greetings and self-introduction', 'title' => ''], 'topicImageList' => [ 'description' => 'A list of image URLs for the topic.', 'type' => 'array', 'items' => ['description' => 'An image URL.', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'sentenceList' => [ 'description' => 'A list of sentence objects.', 'type' => 'array', 'items' => [ 'description' => 'A sentence object.', 'type' => 'object', 'properties' => [ 'sentenceId' => ['description' => 'The sentence ID.', 'type' => 'string', 'example' => '4de677d2509811efbe6e0c42a106bb02', 'title' => ''], 'sentenceText' => ['description' => 'The sentence text.', 'type' => 'string', 'example' => 'I\'m Mike Black', 'title' => ''], 'sentenceAnalysis' => ['description' => 'The sentence analysis.', 'type' => 'string', 'example' => '主语 + be动词（am/is/are） + 姓名.', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'wordList' => [ 'description' => 'A list of word objects.', 'type' => 'array', 'items' => [ 'description' => 'A word object.', 'type' => 'object', 'properties' => [ 'wordId' => ['description' => 'The word ID.', 'type' => 'string', 'example' => 'a94df134ed8c11eebe6e0c42a106bb02', 'title' => ''], 'wordText' => ['description' => 'The word text.', 'type' => 'string', 'example' => 'nice', 'title' => ''], 'wordAnalysis' => ['description' => 'The word analysis.', 'type' => 'string', 'example' => '令人愉快的；友好的', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\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' => 'Retrieve article details', 'changeSet' => [ ['createdAt' => '2025-05-21T09:34:12.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantSceneDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTextbookAssistantArticles' => [ 'summary' => 'Returns a list of articles.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'directoryId' => ['description' => 'The directory ID. Obtain this ID by calling the API to retrieve textbook directories.', 'type' => 'string', 'required' => true, 'example' => '90aa861b4d9311efbe6e0c42a106bb02', 'title' => ''], 'authToken' => ['description' => 'The authorization token. Obtain this token from the API to send Service Window messages.', 'type' => 'string', 'required' => true, 'example' => 'tc_a893b8492c4be046cbc906c566aeb8c9', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '70412360-4272-571A-827D-84C2C07C450F'], 'success' => [ 'description' => 'Indicates whether the API call succeeded.'."\n" ."\n" .'- **true**: The call succeeded.'."\n" ."\n" .'- **false**: The call failed.', 'enumValueTitles' => [], 'type' => 'boolean', 'example' => 'true', 'title' => '', ], 'errCode' => ['description' => 'The error code.'."\n" ."\n" .'- A value of 0 indicates success.'."\n" ."\n" .'- A value greater than 0 indicates a specific error.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The returned data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'articleId' => ['description' => 'The article ID.', 'type' => 'string', 'example' => '0c05700d4d9411efbe6e0c42a106bb02', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Obtain the article list of English textbooks', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantArticles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTextbookAssistantBookDirectories' => [ 'summary' => 'Gets the table of contents of a book.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'bookId' => ['description' => 'The book ID. You can obtain this ID from the API for retrieving English textbooks.', 'type' => 'string', 'required' => true, 'example' => '231698', 'title' => ''], 'scenario' => [ 'description' => 'The exercise scenario.', 'enumValueTitles' => ['EXPAND' => 'Supplementary exercise.', 'ALL' => 'All scenarios.', 'SYNC' => 'Synchronous exercise.'], 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SYNC', 'default' => 'SYNC', 'enum' => ['SYNC', 'EXPAND', 'ALL'], 'title' => '', ], 'authToken' => ['description' => 'The API authorization token. You can obtain this token from the authorization API for the AI English teacher feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'Response schema.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0A5E9849-A2F0-551D-A7D8-1A8118557BAB'], 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'B_USER_NOT_FOUND_EXCEPTION', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '用户不存在', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'editionInfo' => [ 'description' => 'The edition details.', 'type' => 'object', 'properties' => [ 'bookId' => ['description' => 'The book ID.', 'type' => 'string', 'example' => '55857', 'title' => ''], 'isbn' => ['description' => 'The International Standard Book Number (ISBN).', 'type' => 'string', 'example' => '9787544413695', 'title' => ''], 'edition' => ['description' => 'The edition.', 'type' => 'string', 'example' => '2010-1(2)', 'title' => ''], 'impression' => ['description' => 'The impression.', 'type' => 'string', 'example' => '2019-1(10)', 'title' => ''], 'publisher' => ['description' => 'The publisher.', 'type' => 'string', 'example' => '人民教育出版社', 'title' => ''], 'version' => ['description' => 'The version.', 'type' => 'string', 'example' => '人教版', 'title' => ''], 'subject' => ['description' => 'The subject.', 'type' => 'string', 'example' => 'ENGLISH', 'title' => ''], 'grade' => ['description' => 'The grade. Valid values: 1–9.', 'type' => 'string', 'example' => '3', 'title' => ''], 'bookVolume' => ['description' => 'The book volume. `0` indicates a single-volume edition, `1` indicates Volume 1, and `2` indicates Volume 2.', 'type' => 'string', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'directoryTree' => [ 'description' => 'The directory tree.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'directoryId' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => '05758807ed8e11eebe6e0c42a106bb02', 'title' => ''], 'directoryName' => ['description' => 'The directory name.', 'type' => 'string', 'example' => '2 Jobs', 'title' => ''], 'topic' => [ 'description' => 'The topic.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'labelId' => ['description' => 'The label ID.', 'type' => 'string', 'example' => '1323', 'title' => ''], 'labelName' => ['description' => 'The label name.', 'type' => 'string', 'example' => '身边事物环境', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'unit' => [ 'description' => 'The unit.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'directoryId' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => '05758807ed8e11eebe6e0c42a106bb02', 'title' => ''], 'directoryName' => ['description' => 'The directory name.', 'type' => 'string', 'example' => 'unit 2', 'title' => ''], 'topic' => [ 'description' => 'The topic.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'labelId' => ['description' => 'The label ID.', 'type' => 'string', 'example' => '1326', 'title' => ''], 'labelName' => ['description' => 'The label name.', 'type' => 'string', 'example' => '自我介绍', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'section' => [ 'description' => 'The section.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'directoryId' => ['description' => 'The directory ID.', 'type' => 'string', 'example' => '05758807ed8e11eebe6e0c42a106bb02', 'title' => ''], 'directoryName' => ['description' => 'The directory name.', 'type' => 'string', 'example' => 'section 2', 'title' => ''], 'topic' => [ 'description' => 'The topic.', 'type' => 'array', 'items' => [ 'description' => 'Topic details.', 'type' => 'object', 'properties' => [ 'labelId' => ['description' => 'The label ID.', 'type' => 'string', 'example' => '1329', 'title' => ''], 'labelName' => ['description' => 'The label name.', 'type' => 'string', 'example' => '自我介绍', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'children' => ['description' => 'Child nodes for backward compatibility. This property is optional.', 'type' => 'any', 'example' => '可能存在的子元素，兼容数据使用，不一定存在', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"0A5E9849-A2F0-551D-A7D8-1A8118557BAB\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"B_USER_NOT_FOUND_EXCEPTION\\",\\n \\"errMessage\\": \\"用户不存在\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"editionInfo\\": {\\n \\"bookId\\": \\"55857\\",\\n \\"isbn\\": \\"9787544413695\\",\\n \\"edition\\": \\"2010-1(2)\\",\\n \\"impression\\": \\"2019-1(10)\\",\\n \\"publisher\\": \\"人民教育出版社\\",\\n \\"version\\": \\"人教版\\",\\n \\"subject\\": \\"ENGLISH\\",\\n \\"grade\\": \\"3\\",\\n \\"bookVolume\\": \\"1\\"\\n },\\n \\"directoryTree\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"2 Jobs\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1323\\",\\n \\"labelName\\": \\"身边事物环境\\"\\n }\\n ],\\n \\"unit\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"unit 2\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1326\\",\\n \\"labelName\\": \\"自我介绍\\"\\n }\\n ],\\n \\"section\\": [\\n {\\n \\"directoryId\\": \\"05758807ed8e11eebe6e0c42a106bb02\\",\\n \\"directoryName\\": \\"section 2\\",\\n \\"topic\\": [\\n {\\n \\"labelId\\": \\"1329\\",\\n \\"labelName\\": \\"自我介绍\\"\\n }\\n ],\\n \\"children\\": \\"可能存在的子元素，兼容数据使用，不一定存在\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', 'title' => 'Retrieve the book directory of English textbooks', 'changeSet' => [ ['createdAt' => '2025-05-21T09:34:12.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantBookDirectories', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTextbookAssistantBooks' => [ 'summary' => 'Retrieves a list of books for a specified grade.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'bookId' => ['description' => 'The book ID.', 'type' => 'string', 'required' => false, 'example' => '231698', 'title' => ''], 'grade' => ['description' => 'The grade level. The value is a string from "1" to "9".', 'type' => 'string', 'required' => false, 'example' => '1'."\n", 'title' => ''], 'volume' => ['description' => 'The volume. Valid values: 0 (all-in-one volume), 1 (first volume), and 2 (second volume).', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], 'version' => ['description' => 'The textbook version.', 'type' => 'string', 'required' => false, 'example' => '人教版', 'title' => ''], 'page' => ['description' => 'The page number.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], 'maxResults' => ['description' => 'The maximum number of results to return per page. The value cannot exceed 20.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], 'authToken' => ['description' => 'The authorization token for the API call. You can obtain this token by calling the authorization API for the AI textbook assistant feature.', 'type' => 'string', 'required' => true, 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'B695B377-7029-5805-9DE2-1AAE06C1BF6B'], 'success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'B_USER_NOT_FOUND_EXCEPTION', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '用户不存在', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The data object in the response.', 'type' => 'object', 'properties' => [ 'paginationData' => [ 'description' => 'The pagination data.', 'type' => 'object', 'properties' => [ 'totalCount' => ['description' => 'The total number of items.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'maxResults' => ['description' => 'The maximum number of items per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'currentPage' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], 'title' => '', 'example' => '', ], 'bookList' => [ 'description' => 'A list of book objects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'bookId' => ['description' => 'The book ID.', 'type' => 'string', 'example' => '231698', 'title' => ''], 'isbn' => ['description' => 'The International Standard Book Number (ISBN).', 'type' => 'string', 'example' => '9787107382505', 'title' => ''], 'edition' => ['description' => 'The edition.', 'type' => 'string', 'example' => '2024-7（1）', 'title' => ''], 'impression' => ['description' => 'The impression.', 'type' => 'string', 'example' => '2024-7（1）', 'title' => ''], 'publisher' => ['description' => 'The publisher.', 'type' => 'string', 'example' => '人民教育出版社', 'title' => ''], 'version' => ['description' => 'The textbook version.', 'type' => 'string', 'example' => '人教版', 'title' => ''], 'subject' => ['description' => 'The subject.', 'type' => 'string', 'example' => 'ENGLISH', 'title' => ''], 'grade' => ['description' => 'The grade. Valid values are strings from `"1"` to `"9"`.', 'type' => 'string', 'example' => '3', 'title' => ''], 'volume' => ['description' => 'The volume. Valid values: `"0"` (all-in-one), `"1"` (first semester), and `"2"` (second semester).', 'type' => 'string', 'example' => '0', 'title' => ''], 'author' => ['description' => 'The author.', 'type' => 'string', 'example' => '吴欣', 'title' => ''], 'bookName' => ['description' => 'The book name.', 'type' => 'string', 'example' => 'K12英语-人教版PEP三起-三年级上册', 'title' => ''], 'coverImage' => ['description' => 'The cover image.', 'type' => 'string', 'example' => 'null', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], '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' => 'Obtain English textbook books ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantBooks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTextbookAssistantGradeVolumes' => [ 'summary' => 'Retrieves the available grades and volumes for the Textbook Assistant.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'scenario' => [ 'description' => 'The scenario. Valid values: `SYNC` (synchronized practice) and `EXPAND` (extended practice).', 'type' => 'string', 'required' => true, 'enum' => ['SYNC', 'EXPAND'], 'example' => 'SYNC', 'title' => '', ], 'authToken' => ['description' => 'The authorization token. Obtain this token by calling the API that authorizes the Textbook Assistant feature.', 'type' => 'string', 'required' => false, 'example' => 'tc_197bf5bb81889cc79eb51ae9b8c0cea3', 'title' => ''], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response data.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F3B1AAF2-3041-5AA7-A352-BD5F998FA465'], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The response data.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'textbookVersion' => ['description' => 'The version of the textbook.', 'type' => 'string', 'example' => '人教版', 'title' => ''], 'gradeVolumes' => [ 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'volume' => ['description' => 'The volume. Valid values: `0` (single volume), `1` (Volume 1), and `2` (Volume 2).', 'type' => 'string', 'example' => '1', 'title' => ''], 'grade' => ['description' => 'The grade level. Valid values: 1 to 9.', 'type' => 'string', 'example' => '3', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'description' => 'The grade and volume information.', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Sychro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"F3B1AAF2-3041-5AA7-A352-BD5F998FA465\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"0\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"textbookVersion\\": \\"人教版\\",\\n \\"gradeVolumes\\": [\\n {\\n \\"volume\\": \\"1\\",\\n \\"grade\\": \\"3\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', 'title' => 'Obtain the list of grades that have English textbook resources.', 'changeSet' => [ ['createdAt' => '2025-05-16T03:35:13.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantGradeVolumes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ListTextbookAssistantSceneDetails' => [ 'summary' => 'Get Article Details', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'authToken' => ['description' => 'The API authorization token. You can obtain the token by calling the operation that generates the token for the English Textbook-style AI Teacher feature.', 'type' => 'string', 'required' => false, 'example' => 'tc_e6dc70c890866f4028ca685b6fa29874', 'title' => ''], 'sceneIdList' => [ 'description' => 'A list of scene IDs.', 'type' => 'array', 'items' => ['description' => 'A scene ID.', 'type' => 'string', 'required' => false, 'example' => '38c41b7b509911efbe6e0c42a106bb02', 'title' => ''], 'required' => false, 'title' => '', 'example' => '', ], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['description' => 'Indicates whether the call succeeded.'."\n" ."\n" .'- **true**: The call succeeded.'."\n" ."\n" .'- **false**: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'description' => 'The returned data object.', 'type' => 'array', 'items' => [ 'description' => 'An array of objects containing the scene details.', 'type' => 'object', 'properties' => [ 'sceneId' => ['description' => 'The scene ID.', 'type' => 'string', 'example' => '38c41b7b509911efbe6e0c42a106bb02', 'title' => ''], 'target' => ['description' => 'The practice target.', 'type' => 'string', 'example' => '""', 'title' => ''], 'scene' => ['description' => 'The scene description.', 'type' => 'string', 'example' => 'At school, Carl sees a photo and asks you about your family.', 'title' => ''], 'sceneImageList' => [ 'description' => 'A list of image URLs related to the current scene.', 'type' => 'array', 'items' => ['description' => 'The image URL.', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png', 'title' => ''], 'title' => '', 'example' => '', ], 'sceneTaskList' => [ 'description' => 'The scene task list.', 'type' => 'array', 'items' => [ 'description' => 'The scene task details.', 'type' => 'object', 'properties' => [ 'sceneTask' => ['description' => 'The scene task description.', 'type' => 'string', 'example' => 'Say that this is your dad\'s brother.', 'title' => ''], 'sceneTaskTranslate' => ['description' => 'The translation of the scene task description.', 'type' => 'string', 'example' => '说这是你爸爸的兄弟。', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'theme' => [ 'description' => 'The theme details.', 'type' => 'object', 'properties' => [ 'themeName' => ['description' => 'The theme name.', 'type' => 'string', 'example' => '家庭生活', 'title' => ''], 'themeTranslate' => ['description' => 'The translation of the theme name.', 'type' => 'string', 'example' => 'Family and family life', 'title' => ''], 'themeImageList' => [ 'description' => 'A list of image URLs related to the theme.', 'type' => 'array', 'items' => ['description' => 'The image URL.', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'topic' => [ 'description' => 'The topic details.', 'type' => 'object', 'properties' => [ 'topicName' => ['description' => 'The topic name.', 'type' => 'string', 'example' => '介绍家人', 'title' => ''], 'topicTranslate' => ['description' => 'The translation of the topic name.', 'type' => 'string', 'example' => 'Introducing family members', 'title' => ''], 'topicImageList' => [ 'description' => 'A list of image URLs related to the topic.', 'type' => 'array', 'items' => ['description' => 'The image URL.', 'type' => 'string', 'example' => 'https://xxxxxxx/file_service/dialog/xxxxxx.png', 'title' => ''], 'title' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'sentenceList' => [ 'description' => 'The sentence list.', 'type' => 'array', 'items' => [ 'description' => 'The sentence details.', 'type' => 'object', 'properties' => [ 'sentenceId' => ['description' => 'The sentence ID.', 'type' => 'string', 'example' => 'a774c6d09c4511eebe6e0c42a106bb02', 'title' => ''], 'sentenceText' => ['description' => 'The sentence text.', 'type' => 'string', 'example' => 'Is this your sister?', 'title' => ''], 'sentenceAnalysis' => ['description' => 'The sentence analysis.', 'type' => 'string', 'example' => 'Is + this + your + 家庭成员?', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'wordList' => [ 'description' => 'The word list.', 'type' => 'array', 'items' => [ 'description' => 'The word details.', 'type' => 'object', 'properties' => [ 'wordId' => ['description' => 'The word ID.', 'type' => 'string', 'example' => 'a94c3337ed8c11eebe6e0c42a106bb02', 'title' => ''], 'wordText' => ['description' => 'The word text.', 'type' => 'string', 'example' => 'family', 'title' => ''], 'wordAnalysis' => ['description' => 'The word definition.', 'type' => 'string', 'example' => '家；家庭', 'title' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'roleList' => [ 'description' => 'A list of roles in the scene.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'roleName' => ['description' => 'The role name.', 'type' => 'string', 'example' => 'Carl', 'title' => ''], 'roleNameTranslate' => ['description' => 'The translation of the role name.', 'type' => 'string', 'example' => 'Carl', 'title' => ''], 'introduction' => ['description' => 'The role introduction.', 'type' => 'string', 'example' => 'Carl, a curious boy', 'title' => ''], 'introductionTranslate' => ['description' => 'The translation of the role introduction.', 'type' => 'string', 'example' => 'Carl，一个好奇的男孩', 'title' => ''], 'promoting' => ['description' => 'The role guidance text.', 'type' => 'string', 'example' => 'Hi Noah, who is that in the photo?', 'title' => ''], 'promotingTranslate' => ['description' => 'The translation of the role guidance text.', 'type' => 'string', 'example' => '嗨 Noah，照片里的人是谁？', 'title' => ''], 'roleType' => ['description' => 'The role type:', 'type' => 'string', 'example' => '0', 'title' => ''], ], 'description' => 'The details of a role.', 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], 'sceneTranslate' => ['description' => 'The translation of the scene description.', 'type' => 'string', 'title' => '', 'example' => ''], ], 'title' => '', 'example' => '', ], 'title' => '', 'example' => '', ], ], 'example' => '', ], ], 403 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'RequestId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Message' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Synchro' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Data' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Code' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'Success' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'accessDeniedDetail' => [ 'type' => 'object', 'properties' => [ 'AuthAction' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalDisplayName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalOwnerId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'AuthPrincipalType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'EncodedDiagnosticMessage' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'NoPermissionType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'PolicyType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], ], 'description' => '', 'title' => '', 'example' => '', ], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\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' => 'Retrieve scenario details ', 'changeSet' => [ ['createdAt' => '2025-05-21T09:34:12.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantArticleDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'ModelRouterBillingCostTabs' => [ 'summary' => 'Retrieves the tab configuration for usage monitoring.', 'path' => '/api/v1/modelRouter/open/billing/cost/tabs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'Specifies the maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.', 'title' => 'OpenApiSingleResponse> ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The data object.', 'title' => 'Data object ', 'type' => 'array', 'items' => ['description' => 'The response data structure.', '$ref' => '#/components/schemas/CostTabDTO', 'example' => '[]', 'title' => ''], 'example' => '[]', ], 'maxResults' => ['description' => 'The maximum number of results returned on a single page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": [{"key": "all", "label": "全部", "model_types": []}],'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve the usage monitoring Tab configuration ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterBillingCostTabs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"key\\": \\"all\\",\\n \\"label\\": \\"全部\\",\\n \\"modelTypes\\": [\\n \\"Chat\\"\\n ]\\n }\\n ],\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterChatCompletions' => [ 'path' => '/api/v1/modelRouter/open/chat/completions', 'methods' => ['post'], 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/octet-stream'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'schema' => ['title' => 'Chat request body ', 'description' => 'The request body, which must be a JSON object.', 'type' => 'any', 'example' => ' {'."\n" .' "stream": true,'."\n" .' "messages": ['."\n" .' {'."\n" .' "role": "user",'."\n" .' "content": "1+1"'."\n" .' }'."\n" .' ],'."\n" .' "model_id": 15,'."\n" .' "stream_options": {'."\n" .' "include_usage": true'."\n" .' }'."\n" .' }', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The root object of the response.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'A unique request identifier for troubleshooting.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the request succeeded ', 'description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned when a request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'Contains the core response data.', 'type' => 'any', 'example' => '[]'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": "chatcmpl-xxx", "choices": [{"message": {"role": "assistant", "content": "你好！"}}]},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Chat conversation ', 'summary' => 'Generates a chat completion.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterChatCompletions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": \\"[]\\"\\n}","type":"json"}]', ], 'ModelRouterConfigureClientBalance' => [ 'summary' => 'Configures balance throttling for a department.', 'path' => '/api/v1/modelRouter/open/clients/{id}/balance', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['description' => 'The ID of the department.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'enableBalance' => ['description' => 'Specifies whether to enable balance throttling. Once enabled, this feature cannot be disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], 'balanceType' => ['description' => 'The balance type. Valid values: `amount` or `tokens`. This parameter is required when you first enable balance throttling and cannot be changed afterward.', 'type' => 'string', 'example' => 'amount', 'title' => '', 'required' => false], 'initialBalance' => ['description' => 'The initial balance. This parameter is only applicable when you first enable balance throttling.', 'type' => 'number', 'format' => 'double', 'example' => '100.00', 'title' => '', 'required' => false], ], 'title' => '', 'description' => 'The request body.', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => ['description' => 'The returned data object.', 'example' => '{}', '$ref' => '#/components/schemas/ClientBalanceDTO', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "client_id": 1, "balance": 100.00, "balance_type": "amount", "enable_balance": true},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', 'title' => '', 'description' => 'The returned data.', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'B.Validation.InvalidParameterException', 'errorMessage' => '请求参数无效', 'description' => ''], ], 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'ModelRouterConfigureClientBalance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterConfigureClientBalance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCopyApiKey' => [ 'path' => '/api/v1/modelRouter/open/apikeys/{id}/copy', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Key ID ', 'description' => 'The key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'Details of the copied API key.', 'example' => '[]', '$ref' => '#/components/schemas/ApiKeyDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 2, "name": "复制的Key", "key": "sk-copy"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Copy API key ', 'summary' => 'Copies an API key.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCopyApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCreateApiKey' => [ 'summary' => 'API key management / Create an API key', 'path' => '/api/v1/modelRouter/open/apikeys', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'title' => 'Request body parameters. ', 'properties' => [ 'clientId' => ['title' => 'Customer ID; null indicates the default customer ', 'description' => 'The client ID. A value of `null` represents the default client.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiSingleResponse\\', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates if the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The returned data object.', 'example' => '[]', '$ref' => '#/components/schemas/ApiKeyDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "新Key", "key": "sk-newkey"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Create API key ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCreateBalanceTransaction' => [ 'path' => '/api/v1/modelRouter/open/clients/{id}/balance/transactions', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['description' => 'The department ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'type' => 'object', 'properties' => [ 'type' => ['description' => 'The transaction type.', 'type' => 'string', 'example' => 'recharge', 'title' => '', 'required' => false], 'amount' => ['description' => 'The transaction amount.', 'type' => 'number', 'format' => 'double', 'example' => '100.00', 'title' => '', 'required' => false], 'remark' => ['description' => 'A remark for the transaction.', 'type' => 'string', 'example' => '充值', 'title' => '', 'required' => false], ], 'title' => '', 'description' => 'The request body.', 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => ['description' => 'The data object.', 'example' => '{}', '$ref' => '#/components/schemas/ClientBalanceDTO', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "client_id": 1, "balance": 200.00, "balance_type": "amount", "enable_balance": true},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', 'title' => '', 'description' => 'OpenApiSingleResponse\\', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'ModelRouterCreateBalanceTransaction', 'summary' => 'Client management / Create balance transaction', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateBalanceTransaction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCreateBillingRule' => [ 'path' => '/api/v1/modelRouter/open/billing/rules', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body for creating a billing rule.', 'title' => 'Billing rule creation request ', 'type' => 'object', 'properties' => [ 'modelId' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], 'billingType' => ['title' => 'Billing type: token_tiered/per_image/per_duration/per_character/video_matrix/token_flat/omni_multimodal ', 'description' => 'The billing type. The value must be `configurable`.', 'type' => 'string', 'example' => 'configurable', 'required' => false], 'pricingConfig' => ['title' => 'Billing configuration JSON ', 'description' => 'The `pricingConfig` is a JSON object whose internal field structure varies depending on the billing type.'."\n" ."\n" .'1. **Tiered token billing**
Applicable to chat models. This type uses tiered pricing based on the number of input tokens and supports different rates for standard mode, thinking mode, and cache hits.
JSON format:


'."\n" ."\n" .' Field descriptions:Constraints:'."\n" ."\n" .'2. **Per-image billing**
Applicable to `ImageGeneration` and `ImageEdit` models. Billing is based on the number of images generated or processed.
JSON format:


'."\n" ."\n" .' Field descriptions:'."\n" ."\n" .'3. **Video matrix billing**
Applicable to `VideoGeneration` and `VideoImageGeneration` models. Pricing is based on a combination of video resolution and the presence of an audio track.
Note: While the frontend UI may use a `matrix` field, API calls must use the `tiers` field to save the configuration. The `matrix` field is automatically converted to `tiers` on the server side. The format below is the standard API format.
JSON format:



'."\n" ."\n" .' Field descriptions:Constraints:'."\n" ."\n" .'4. **Billing by duration**
Applicable to automatic speech recognition (ASR) models. Billing is based on the audio duration.
JSON format:


'."\n" ."\n" .' Field descriptions:'."\n" ."\n" .'5. **Per-character billing**
Applicable to text-to-speech (TTS) models. Billing is based on the number of characters in the synthesized text.
JSON format:


'."\n" ."\n" .' Field descriptions:'."\n" ."\n" .'6. **Flat-rate token billing**
Applicable to models such as `Embedding`, `Rerank`, `MultimodalEmbedding`, and `MultimodalRerank`. This type uses a flat-rate pricing model without tiers.
JSON format:


'."\n" ."\n" .' Field descriptions:'."\n" ."\n" .'7. **Full-modal multi-dimensional billing**
Applicable to full-modal models such as `ChatFullmodal` (e.g., `qwen3.5-omni-plus`). It sets separate prices for the input and output of different modalities, such as text, audio, images, and video.
JSON format:


'."\n" ."\n" .' Field descriptions:', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "tiers":['."\n" .' {'."\n" .' "input_price":2.5,'."\n" .' "cached_input_price":2.5,'."\n" .' "max_tokens":32000,'."\n" .' "output_price":10,'."\n" .' "thinking_output_price":10,'."\n" .' "thinking_input_price":2.5,'."\n" .' "min_tokens":0'."\n" .' },'."\n" .' {'."\n" .' "input_price":4,'."\n" .' "cached_input_price":4,'."\n" .' "max_tokens":128000,'."\n" .' "output_price":16,'."\n" .' "thinking_output_price":16,'."\n" .' "thinking_input_price":4,'."\n" .' "min_tokens":32000'."\n" .' },'."\n" .' {'."\n" .' "input_price":7,'."\n" .' "cached_input_price":7,'."\n" .' "max_tokens":252000,'."\n" .' "output_price":28,'."\n" .' "thinking_output_price":28,'."\n" .' "thinking_input_price":7,'."\n" .' "min_tokens":128000'."\n" .' }'."\n" .' ]'."\n" .' }'], 'effectiveTime' => ['title' => 'Effective period, in RFC3339 format ', 'description' => 'The effective time, in RFC3339 format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'required' => false], 'expireTime' => ['title' => 'Time-to-live (TTL), in RFC3339 format ', 'description' => 'The expiration time, in RFC3339 format.', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z', 'required' => false], 'version' => ['title' => 'Billing rule version number ', 'description' => 'The billing rule version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'Contains the details of the billing rule.', 'title' => 'Returned Data ', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Rule ID', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelId' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelCode' => ['title' => 'Model identity', 'description' => 'The model code.', 'type' => 'string', 'example' => 'qwen-plus'], 'modelName' => ['title' => 'Model Name', 'description' => 'The model name.', 'type' => 'string', 'example' => '通义千问Plus'], 'modelType' => ['title' => 'Model Type ', 'description' => 'The model type.', 'type' => 'string', 'example' => 'chat'], 'symbol' => ['title' => 'Vendor Identity ', 'description' => 'The provider identifier.', 'type' => 'string', 'example' => 'alibaba'], 'billingType' => ['title' => 'Billing type', 'description' => 'The billing type.', 'type' => 'string', 'example' => 'token_tiered'], 'pricingConfig' => ['title' => 'Billing configuration', 'description' => 'The pricing configuration.', 'type' => 'any', 'example' => '{}'], 'effectiveTime' => ['title' => 'Effective Period ', 'description' => 'The effective time of the rule.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'expireTime' => ['title' => 'Time-to-live (TTL)', 'description' => 'The expiration time of the rule.', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'], 'version' => ['title' => 'Version Number ', 'description' => 'The version of the rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'deleteTag' => ['title' => 'Delete marker', 'description' => 'The delete marker.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'gmtCreate' => ['title' => 'Creation Time ', 'description' => 'The creation time of the rule.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => 'Updated At ', 'description' => 'The modification time of the rule.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'example' => '', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "model_id": 1, "billing_type": "token_tiered"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 200 => [ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''], ], 403 => [ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => 'Authentication failed-Organization does not exist'], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Billing Management / Creation of Billing Rule ', 'summary' => 'Billing Management/Create Billing Rule', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateBillingRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问Plus\\",\\n \\"modelType\\": \\"chat\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"billingType\\": \\"token_tiered\\",\\n \\"pricingConfig\\": \\"{}\\",\\n \\"effectiveTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"expireTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"version\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCreateClient' => [ 'summary' => 'Client management / Create client', 'path' => '/api/v1/modelRouter/open/clients', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'title' => 'Request body parameters', 'properties' => [ 'name' => ['title' => 'Customer Name ', 'description' => 'The client name.', 'type' => 'string', 'example' => '我的客户', 'required' => false], 'address' => ['title' => 'Company address', 'description' => 'The company address.', 'type' => 'string', 'example' => '杭州市', 'required' => false], 'contact' => ['title' => 'Contact information', 'description' => 'The contact information.', 'type' => 'string', 'example' => '13800138000', 'required' => false], 'remark' => ['title' => 'Remark information ', 'description' => 'Additional remarks.', 'type' => 'string', 'example' => '备注', 'required' => false], 'allowedModels' => ['title' => 'Comma-separated list of allowed model IDs; empty indicates all models are allowed', 'description' => 'A comma-separated list of model IDs that the client can use. If this parameter is empty, the client can use all available models.', 'type' => 'string', 'example' => '1,2,3', 'required' => false], 'discount' => ['type' => 'number', 'format' => 'double', 'example' => '1.0', 'description' => '', 'title' => ''], 'parentId' => ['type' => 'integer', 'format' => 'int64', 'example' => '1', 'description' => '', 'title' => ''], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'The data object.', 'example' => '[]', '$ref' => '#/components/schemas/ClientDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "新客户"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Create Customer', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCreateConversation' => [ 'summary' => 'Conversation management / Create conversation', 'path' => '/api/v1/modelRouter/open/conversations', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'properties' => [ 'chatData' => ['title' => 'Conversation data in JSON format, containing message records for each model (required)', 'description' => 'The conversation data, provided as a JSON string containing the message history for each model. This parameter is required.', 'type' => 'string', 'example' => '{"stream":true,"messages":[{"role":"user","content":"1+1"}],"model":"qwen/qwen-max/r0","stream_options":{"include_usage":true}}', 'required' => false], 'modelIds' => ['title' => 'List of model IDs, as a JSON array string', 'description' => 'A list of model IDs, provided as a JSON array string.', 'type' => 'string', 'example' => '15', 'required' => false], 'title' => ['title' => 'Conversation title; if not provided, it is automatically extracted from the first user message', 'description' => 'The conversation title. If omitted, a title is automatically generated from the first user message.', 'type' => 'string', 'example' => 'test', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiSingleResponse', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'Request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message code', 'description' => 'Error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'Error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'Data object.', 'example' => '[]', '$ref' => '#/components/schemas/ConversationDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "title": "新对话"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Create Session', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterCreateModel' => [ 'summary' => 'Creates a model.', 'path' => '/api/v1/modelRouter/open/models', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'title' => 'Request struct', 'type' => 'object', 'properties' => [ 'name' => ['title' => 'Model name ', 'description' => 'The model name.', 'type' => 'string', 'example' => '通义千问', 'required' => false], 'description' => ['title' => 'Model description ', 'description' => 'The model description.', 'type' => 'string', 'example' => '通义千问大模型', 'required' => false], 'symbol' => ['title' => 'Vendor symbol', 'description' => 'The vendor symbol.', 'type' => 'string', 'example' => 'alibaba', 'required' => false], 'tags' => ['title' => 'Labels, comma-separated ', 'description' => 'Tags for the model. Separate multiple tags with commas.', 'type' => 'string', 'example' => 'TXT_GEN,DEEP_THINK', 'required' => false], 'modelId' => ['title' => 'Model identity ', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'qwen-turbo', 'required' => false], 'modelType' => ['title' => 'Model type ', 'description' => 'The model type.', 'type' => 'string', 'example' => 'Chat', 'required' => false], 'apiKey' => ['title' => 'API key ', 'description' => 'The API key.', 'type' => 'string', 'example' => 'sk-xxxx', 'required' => false], 'baseUrl' => ['title' => 'Base URL', 'description' => 'The base URL.', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com', 'required' => false], 'maxInputLength' => ['title' => 'Maximum input length', 'description' => 'The maximum input length.', 'type' => 'string', 'example' => '32K', 'required' => false], 'maxOutputLength' => ['title' => 'Maximum output length ', 'description' => 'The maximum output length.', 'type' => 'string', 'example' => '8K', 'required' => false], 'inOut' => ['description' => 'The supported input and output data types for the model.', 'type' => 'string', 'example' => 'text', 'title' => '', 'required' => false], 'extensions' => ['description' => 'The model\'s extended configuration parameters, provided as a JSON string.', 'type' => 'string', 'example' => '{}', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiSingleResponse', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'The data object.', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "gpt-4", "type": "chat"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'Model Creation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterDeleteApiKey' => [ 'summary' => 'API Key Management / Delete API Key', 'path' => '/api/v1/modelRouter/open/apikeys/{id}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Key ID', 'description' => 'The ID of the API key to delete.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded.', 'description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'Whether the deletion was successful.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": true,'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Delete API key', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]', ], 'ModelRouterDeleteClient' => [ 'summary' => 'Deletes a client.', 'path' => '/api/v1/modelRouter/open/clients/{id}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Customer ID', 'description' => 'The client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'An `OpenApiSingleResponse` object that contains the response data.', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'Whether the client was deleted successfully.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": true,'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Delete Customer', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]', ], 'ModelRouterDeleteConversation' => [ 'summary' => 'Conversation management/Delete conversation', 'path' => '/api/v1/modelRouter/open/conversations/{id}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Session ID ', 'description' => 'The ID of the conversation to delete.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique request ID. Include this ID when contacting technical support.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'A value of true indicates that the conversation was successfully deleted.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": true,'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Delete Session ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]', ], 'ModelRouterDeleteModel' => [ 'path' => '/api/v1/modelRouter/open/models/{id}', 'methods' => ['delete'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Model ID', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The API response.', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the API call was processed successfully.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'Indicates if the model was successfully deleted.', 'type' => 'boolean', 'example' => 'true'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": true,'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Delete Model', 'summary' => 'Model Management / Delete Model', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": true\\n}","type":"json"}]', ], 'ModelRouterGetClientBalance' => [ 'summary' => 'Client Management/Get department balance', 'path' => '/api/v1/modelRouter/open/clients/{id}/balance', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['description' => 'The ID of the department.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Specifies if the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => ['description' => 'The data object.', 'example' => '{}', '$ref' => '#/components/schemas/ClientBalanceDTO', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "client_id": 1, "balance": 100.00, "balance_type": "amount", "enable_balance": true},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', 'title' => '', 'description' => 'OpenApiSingleResponse', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'ModelRouterGetClientBalance', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterGetClientBalance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterGetClientBalanceLogs' => [ 'summary' => 'Gets the balance change log for a specified department.', 'path' => '/api/v1/modelRouter/open/clients/{id}/balance/logs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['description' => 'The department ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'changeType', 'in' => 'query', 'schema' => ['description' => 'Filters the logs by change type. Valid values: auto\\_deduct, deduct, and recharge.', 'type' => 'string', 'example' => 'recharge', 'title' => '', 'required' => false], ], [ 'name' => 'page', 'in' => 'query', 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'size', 'in' => 'query', 'schema' => ['description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'title' => '', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of entries to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token for the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'None', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned on failure.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned on failure.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'type' => 'object', 'properties' => [ 'total' => ['description' => 'The total number of matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'pageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'list' => [ 'type' => 'array', 'items' => ['description' => 'A balance change log entry.', '$ref' => '#/components/schemas/ClientBalanceLogDTO', 'title' => '', 'example' => ''], 'title' => '', 'description' => 'A list of balance change log entries.', 'example' => '', ], ], 'title' => '', 'description' => 'The returned data.', 'example' => '', ], 'maxResults' => ['description' => 'The maximum number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], 'nextToken' => ['description' => 'The pagination token for the next page of results. An empty value indicates that no more results are available.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 20,'."\n" .' "list": [{"id": 1, "client_id": 1, "change_amount": 100.00, "change_type": "recharge"}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', 'title' => '', 'description' => 'OpenApiPageResponse', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'ModelRouterGetClientBalanceLogs', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterGetClientBalanceLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 100,\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"changeAmount\\": 10,\\n \\"balanceBefore\\": 90,\\n \\"balanceAfter\\": 100,\\n \\"changeType\\": \\"recharge\\",\\n \\"remark\\": \\"充值\\",\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"None\\"\\n}","type":"json"}]', ], 'ModelRouterQueryApiKey' => [ 'summary' => 'Retrieves the details of a specific API key.', 'path' => '/api/v1/modelRouter/open/apikeys/{id}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Key ID ', 'description' => 'The API key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Specifies if the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code, returned only if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message, returned only if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object containing the API key details.', 'example' => '[]', '$ref' => '#/components/schemas/ApiKeyDecryptedDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "测试Key", "key": "sk-xxx", "decryptedKey": "sk-full-key"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve API key information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"key\\": \\"sk-xxxxxxxxxxxxxxxxxxx\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterQueryApiKeyList' => [ 'summary' => 'Retrieves a list of API keys.', 'path' => '/api/v1/modelRouter/open/apikeys', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page ', 'description' => 'The number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number ', 'description' => 'The page number to retrieve.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field ', 'description' => 'The sort field.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction ', 'description' => 'The sort order.', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'Grouping field', 'description' => 'The grouping field.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required ', 'description' => 'Specifies whether to return the total count of results.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results ', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'keyword', 'in' => 'query', 'schema' => ['title' => 'Search keyword', 'description' => 'The search keyword.', 'type' => 'string', 'example' => 'test', 'required' => false], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Customer ID filter ', 'description' => 'Filters the results by the specified client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'status', 'in' => 'query', 'schema' => ['title' => 'Status filter', 'description' => 'Filters the results by the specified status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => 'nextToken ', 'description' => 'The token for retrieving the next page of results. An empty value indicates that all results have been returned.', 'type' => 'string', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiPageResponse', 'title' => 'OpenApiPageResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'An array of API key objects.', 'title' => 'Data object', 'type' => 'object', 'items' => ['description' => '返回数据对象', 'extendType' => 'true', '$ref' => '#/components/schemas/ApiKeyDTO'], 'example' => '[]', 'properties' => [ 'total' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => '', 'description' => ''], 'maxResult' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''], 'page' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'description' => ''], 'list' => [ 'type' => 'array', 'items' => ['example' => '{'."\n" .' "gmt_create":"2026-03-19T10:44:16.139455+08:00",'."\n" .' "delete_tag":0,'."\n" .' "name":"阿斯旺答授权",'."\n" .' "client":{'."\n" .' "gmt_create":"2026-03-19T10:44:06.176949+08:00",'."\n" .' "address":"1222222222222",'."\n" .' "delete_tag":0,'."\n" .' "contact":"11111111",'."\n" .' "name":"阿斯旺答",'."\n" .' "client_uuid":"st_ehe8K1F05A2QK",'."\n" .' "remark":"222222222",'."\n" .' "main":1,'."\n" .' "id":51,'."\n" .' "gmt_modified":"2026-03-19T10:44:06.17695+08:00",'."\n" .' "allowed_models":"79"'."\n" .' },'."\n" .' "key_preview":"sk-4a8c****cb20",'."\n" .' "id":104,'."\n" .' "gmt_modified":"2026-03-19T10:44:16.139456+08:00",'."\n" .' "client_id":51,'."\n" .' "key":""'."\n" .' }', '$ref' => '#/components/schemas/ApiKeyDTO', 'title' => '', 'description' => ''], 'title' => '', 'description' => '', 'example' => '', ], 'nextToken' => ['type' => 'string', 'example' => 'None', 'title' => '', 'description' => ''], 'pageSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => '', 'description' => ''], ], ], 'maxResults' => ['title' => 'maxResults', 'description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": [{"id": 1, "name": "测试Key", "key": "sk-xxx"}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve API key list ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryApiKeyList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 0,\\n \\"maxResult\\": \\"\\",\\n \\"page\\": 1,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"MyApiKey\\",\\n \\"client\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"keyPreview\\": \\"sk-xxx****xxx\\",\\n \\"clientId\\": 1,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ],\\n \\"nextToken\\": \\"None\\",\\n \\"pageSize\\": 10\\n },\\n \\"maxResults\\": 10\\n}","type":"json"}]', ], 'ModelRouterQueryBillingCostBreakdown' => [ 'path' => '/api/v1/modelRouter/open/billing/cost/breakdown', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Start Time of the query, UNIX timestamp (seconds) ', 'description' => 'The start time for the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'End Time of the query, UNIX timestamp (seconds) ', 'description' => 'The end time for the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'], ], [ 'name' => 'granularity', 'in' => 'query', 'schema' => ['title' => 'Aggregation granularity: hourly or daily ', 'description' => 'The granularity for data aggregation. Valid values: `hourly` and `daily`.', 'type' => 'string', 'required' => true, 'example' => 'hourly'], ], [ 'name' => 'page', 'in' => 'query', 'schema' => ['title' => 'Page number, default is 1 ', 'description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of entries per page, default is 20, maximum is 500 ', 'description' => 'The number of entries per page. Default: 20. Maximum: 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the model to query. If not specified, data for all models is returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['description' => 'The ID of the client to query. If not specified, data for all clients is returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100', 'description' => '', 'title' => ''], ], [ 'name' => 'modelTypes', 'in' => 'query', 'schema' => ['description' => 'The types of the models to query, separated by commas. For example: `Chat,Embedding`. If not specified, data for all model types is returned.', 'type' => 'string', 'example' => 'Chat', 'title' => ''], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results to return ', 'description' => 'The maximum number of results to return. This parameter is used for pagination along with `nextToken` and is mutually exclusive with `page` and `pageSize`.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => 'Pagination token ', 'description' => 'The pagination token that is used to retrieve the next page of results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the request succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object containing the billing breakdown. For details, see the response example.', 'example' => '{}', '$ref' => '#/components/schemas/BillingCostBreakdownRespDTO'], 'maxResults' => ['title' => 'Maximum number of returned items ', 'description' => 'The maximum number of results returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'nextToken' => ['title' => 'Pagination token ', 'description' => 'The pagination token. If this parameter is not empty, pass its value in a subsequent request to retrieve the next page of results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"granularity": "hourly", "total": 100, "page": 1, "page_size": 20, "rows": []},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Batch Query Billing Details ', 'summary' => 'Billing > Query billing cost breakdown', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryBillingCostBreakdown', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"granularity\\": \\"hourly\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"total\\": 100,\\n \\"columns\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"rows\\": [\\n {\\n \\"summaryTime\\": 1700000000,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"modelType\\": \\"llm\\",\\n \\"clientId\\": 0,\\n \\"clientName\\": \\"研发部\\",\\n \\"apiKeyId\\": 0,\\n \\"apiKeyName\\": \\"默认密钥\\",\\n \\"billingType\\": \\"total_amount\\",\\n \\"payableAmount\\": 0.000128,\\n \\"dimValues\\": \\"{\\\\\\"billing_version\\\\\\": \\\\\\"v1\\\\\\"}\\",\\n \\"values\\": \\"{\\\\\\"input_tokens\\\\\\": 512000, \\\\\\"output_tokens\\\\\\": 256000}\\",\\n \\"tiers\\": [\\n {\\n \\"dimValues\\": \\"{\\\\\\"context_tier\\\\\\": \\\\\\"0-32k\\\\\\"}\\",\\n \\"values\\": \\"{\\\\\\"input_tokens\\\\\\": 1000, \\\\\\"output_tokens\\\\\\": 500}\\",\\n \\"payableAmount\\": 0.05\\n }\\n ]\\n }\\n ]\\n },\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterQueryBillingRuleList' => [ 'path' => '/api/v1/modelRouter/open/billing/rules', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'page', 'in' => 'query', 'schema' => ['title' => 'Page number, default 1', 'description' => 'Page number. Default is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number per page, default 20', 'description' => 'Number of items per page. Default is 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number (preferred)', 'description' => 'Page number (takes precedence).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'modelType', 'in' => 'query', 'schema' => ['title' => 'Model type filter ', 'description' => 'Filter by model type.', 'type' => 'string', 'example' => 'chat', 'required' => false], ], [ 'name' => 'modelCode', 'in' => 'query', 'schema' => ['title' => 'Model identity filter', 'description' => 'Filter by model identifier.', 'type' => 'string', 'example' => 'qwen-plus', 'required' => false], ], [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['title' => 'Model ID filter', 'description' => 'Filter by model ID (required).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'activeOnly', 'in' => 'query', 'schema' => ['title' => 'Return only currently effective rules', 'description' => 'Return only currently effective rules.', 'type' => 'boolean', 'example' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'nextToken', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiPageResponse', 'title' => 'OpenApiPageResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'Request ID', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'Error code', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message', 'description' => 'Error message', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'HTTP status code', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'Response data', 'title' => 'Returned Data ', 'type' => 'object', 'properties' => [ 'total' => ['title' => 'Total Records ', 'description' => 'Total number of records', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'page' => ['title' => 'Current Page Number ', 'description' => 'Current page number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'pageSize' => ['title' => 'Quantity per Page ', 'description' => 'Number of items per page', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'list' => [ 'description' => 'List of billing rules', 'title' => 'Billing Rule List ', 'type' => 'array', 'items' => [ 'description' => 'Billing rule', 'title' => 'Billing Rule ', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Rule ID ', 'description' => 'Rule ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelId' => ['title' => 'Model ID ', 'description' => 'Model ID', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelCode' => ['title' => 'Model identity ', 'description' => 'Model identifier', 'type' => 'string', 'example' => 'qwen-plus'], 'modelName' => ['title' => 'Model Name ', 'description' => 'Model name', 'type' => 'string', 'example' => '通义千问Plus'], 'modelType' => ['title' => 'Model type ', 'description' => 'Model type', 'type' => 'string', 'example' => 'chat'], 'symbol' => ['title' => 'Vendor Identity ', 'description' => 'Vendor identifier', 'type' => 'string', 'example' => 'alibaba'], 'billingType' => ['title' => 'Billing type ', 'description' => 'Billing type', 'type' => 'string', 'example' => 'token_tiered'], 'pricingConfig' => ['title' => 'Billing configuration ', 'description' => 'Billing configuration', 'type' => 'any', 'example' => '{}'], 'effectiveTime' => ['title' => 'Effective period ', 'description' => 'Effective time', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'expireTime' => ['title' => 'Time-to-live (TTL) ', 'description' => 'Expiration time', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'], 'version' => ['title' => 'Version number ', 'description' => 'Version number', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'deleteTag' => ['title' => 'Delete marker ', 'description' => 'Delete marker', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'gmtCreate' => ['title' => 'Creation Time ', 'description' => 'Creation time', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => 'Updated At ', 'description' => 'Modification time', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'example' => '', ], 'example' => '', ], ], 'example' => '', ], 'maxResults' => ['description' => 'maxResults', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'nextToken' => ['description' => 'nextToken', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "page_size": 20,'."\n" .' "list": []'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => 'Authentication failed-Organization does not exist'], ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Billing Management / Query Billing Rule List', 'summary' => 'Billing management / Query billing rule list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryBillingRuleList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 5,\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问Plus\\",\\n \\"modelType\\": \\"chat\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"billingType\\": \\"token_tiered\\",\\n \\"pricingConfig\\": \\"{}\\",\\n \\"effectiveTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"expireTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"version\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterQueryClientDiscountLogs' => [ 'path' => '/api/v1/modelRouter/open/clients/{id}/discount-logs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Customer ID', 'description' => 'The client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results. Omit this parameter to get the first page.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiResponse> ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Success ', 'description' => 'Indicates if the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error Code ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error Message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP Status Code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The list of discount modification logs.', 'title' => 'List of discount modification history ', 'type' => 'array', 'items' => [ 'description' => 'A single discount modification log.', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Record ID ', 'description' => 'The record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'clientId' => ['title' => 'Customer ID ', 'description' => 'The client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'discount' => ['title' => 'Discount ', 'description' => 'The discount.', 'type' => 'number', 'format' => 'float', 'example' => '0.5'], 'effectiveTime' => ['title' => 'effective period ', 'description' => 'The time when the discount took effect.', 'type' => 'string', 'example' => '2025-09-01 00:00:00'], 'expireTime' => ['title' => 'time-to-live (TTL) ', 'description' => 'The time when the discount expires.', 'type' => 'string', 'example' => '2025-09-10 00:00:00'], 'remark' => ['title' => 'Remark ', 'description' => 'The remark.', 'type' => 'string', 'example' => '备注'], 'deleteTag' => ['title' => 'delete marker ', 'description' => 'A flag that indicates whether the record is deleted. A value of 0 means the record is active.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], 'gmtCreate' => ['title' => 'Creation Time ', 'description' => 'The time when the record was created.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => 'Updated At ', 'description' => 'The time when the record was last modified.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'nextToken' => ['description' => 'The token to use in a subsequent request to retrieve the next page of results. If this parameter is not returned, all results have been retrieved.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], 'maxResults' => ['description' => 'The maximum number of results returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": [{"id": 1, "client_id": 1, "old_discount": 1.0, "new_discount": 0.8, "remark": "调整折扣"}],'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => 'Authentication failed-Organization does not exist'], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Customer Management / Retrieve Department Discount Modification History ', 'summary' => 'Retrieves the discount modification history for a client.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryClientDiscountLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"discount\\": 0.5,\\n \\"effectiveTime\\": \\"2025-09-01 00:00:00\\",\\n \\"expireTime\\": \\"2025-09-10 00:00:00\\",\\n \\"remark\\": \\"备注\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ],\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"maxResults\\": 10\\n}","type":"json"}]', ], 'ModelRouterQueryClientList' => [ 'path' => '/api/v1/modelRouter/open/clients', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page ', 'description' => 'The number of entries to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number ', 'description' => 'The page number of the results to return. The first page is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field ', 'description' => 'The field to sort the results by.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction ', 'description' => 'The sort direction.', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'Grouping field ', 'description' => 'The field to group the results by.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required ', 'description' => 'Specifies whether to return the total count of entries.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results ', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'keyword', 'in' => 'query', 'schema' => ['title' => 'Search keyword', 'description' => 'The search keyword.', 'type' => 'string', 'example' => 'test', 'required' => false], ], [ 'name' => 'status', 'in' => 'query', 'schema' => ['title' => 'Status Filter', 'description' => 'Filters the results by status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => 'nextToken ', 'description' => 'The token for the next page of results. Set this to the nextToken value from the previous response. Omit for the first page.', 'type' => 'string', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiPageResponse\\', 'title' => 'OpenApiPageResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the request succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'A wrapper object for the paged response data.', 'title' => 'Data object ', 'type' => 'object', 'items' => ['description' => '返回数据。', 'extendType' => 'true', '$ref' => '#/components/schemas/ClientDTO'], 'example' => '[]', 'properties' => [ 'total' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'maxResults' => ['type' => 'string', 'example' => '1', 'description' => '', 'title' => ''], 'page' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'nextToken' => ['type' => 'string', 'example' => '1', 'description' => '', 'title' => ''], 'pageSize' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], 'list' => [ 'type' => 'array', 'items' => ['example' => '{'."\n" .' "gmt_create":"2026-03-19T10:44:06.176949+08:00",'."\n" .' "address":"1222222222222",'."\n" .' "delete_tag":0,'."\n" .' "contact":"11111111",'."\n" .' "name":"阿斯旺答",'."\n" .' "client_uuid":"st_ehe8K1F05A2QK",'."\n" .' "remark":"222222222",'."\n" .' "main":1,'."\n" .' "id":51,'."\n" .' "gmt_modified":"2026-03-19T10:44:06.17695+08:00",'."\n" .' "allowed_models":"79"'."\n" .' }', '$ref' => '#/components/schemas/ClientDTO', 'description' => '', 'title' => ''], 'description' => '', 'title' => '', 'example' => '', ], ], ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": [{"id": 1, "name": "测试客户"}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve customer information ', 'summary' => 'Retrieves a list of clients.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryClientList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"total\\": 0,\\n \\"maxResults\\": \\"1\\",\\n \\"page\\": 0,\\n \\"nextToken\\": \\"1\\",\\n \\"pageSize\\": 0,\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], 'ModelRouterQueryClientTree' => [ 'summary' => 'Returns a hierarchical tree of customers.', 'path' => '/api/v1/modelRouter/open/clients/tree', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of items to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiResponse> ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded. ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'An array of objects that form the customer tree.', 'title' => 'Returned data. List of customer tree structures. ', 'type' => 'array', 'items' => ['description' => 'A customer object within the tree structure.', '$ref' => '#/components/schemas/ClientTreeDTO', 'example' => '[]', 'title' => ''], 'example' => '', ], 'nextToken' => ['description' => 'The token to retrieve the next page of results. If this parameter is not returned, it indicates that there are no more results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], 'maxResults' => ['description' => 'The maximum number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "id": 1,'."\n" .' "name": "总公司",'."\n" .' "client_uuid": "st-xxxx",'."\n" .' "level": 1,'."\n" .' "parent_id": null,'."\n" .' "main": 0,'."\n" .' "children": ['."\n" .' {'."\n" .' "id": 2,'."\n" .' "name": "分公司1",'."\n" .' "client_uuid": "st-yyyy",'."\n" .' "level": 2,'."\n" .' "parent_id": 1,'."\n" .' "main": 1,'."\n" .' "children": []'."\n" .' }'."\n" .' ]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Customer Management / Retrieve Customer Tree', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryClientTree', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"discount\\": 1,\\n \\"deleteTag\\": 0,\\n \\"level\\": 1,\\n \\"parentId\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"balance\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"children\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"discount\\": 1,\\n \\"deleteTag\\": 0,\\n \\"level\\": 1,\\n \\"parentId\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"balance\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"children\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"discount\\": 1,\\n \\"deleteTag\\": 0,\\n \\"level\\": 1,\\n \\"parentId\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"balance\\": {\\n \\"id\\": 1,\\n \\"clientId\\": 1,\\n \\"balance\\": 100,\\n \\"balanceType\\": \\"amount\\",\\n \\"enableBalance\\": true,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n },\\n \\"children\\": []\\n }\\n ]\\n }\\n ]\\n }\\n ],\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"maxResults\\": 10\\n}","type":"json"}]', ], 'ModelRouterQueryConversation' => [ 'path' => '/api/v1/modelRouter/open/conversations/{id}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Conversation ID ', 'description' => 'The conversation ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object.', 'example' => '[]', '$ref' => '#/components/schemas/ConversationDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "title": "测试对话"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve Session Details ', 'summary' => 'Retrieves the details of a conversation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterQueryConversationList' => [ 'path' => '/api/v1/modelRouter/open/conversations', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page', 'description' => 'The number of items to return on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field', 'description' => 'The sort field.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction', 'description' => 'The sort order. Valid values are `ASC` (ascending) and `DESC` (descending).', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'grouping field', 'description' => 'The grouping field.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required.', 'description' => 'Specifies whether to return the total count of items. Set to `true` to return the total count.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'keyword', 'in' => 'query', 'schema' => ['title' => 'search keyword', 'description' => 'A keyword to filter the results.', 'type' => 'string', 'example' => 'test', 'required' => false], ], [ 'name' => 'status', 'in' => 'query', 'schema' => ['title' => 'Status filter', 'description' => 'Filters the results by status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => 'nextToken', 'description' => 'The pagination token for the next page of results. To retrieve the first page, do not specify this parameter.', 'type' => 'string', 'example' => '2', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'A paginated response object that contains a list of conversations.', 'title' => 'OpenApiPageResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded.', 'description' => 'Indicates whether the request succeeded. A value of `true` indicates success.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The response data.', 'title' => 'Returned data object ', 'type' => 'object', 'properties' => [ 'list' => [ 'description' => 'A list of conversation objects.', 'title' => 'List ', 'type' => 'array', 'items' => ['title' => 'Element ', 'description' => 'A conversation object.', 'example' => '{'."\n" .' "gmt_create":"2026-03-19T18:13:30.777767+08:00",'."\n" .' "id":124,'."\n" .' "title":"hi",'."\n" .' "gmt_modified":"2026-03-19T18:13:30.777767+08:00",'."\n" .' "message_count":2,'."\n" .' "model_ids":"[77]"'."\n" .' },', '$ref' => '#/components/schemas/ConversationDTO'], 'example' => '', ], 'total' => ['title' => 'Total quantity ', 'description' => 'The total number of conversations.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'page' => ['title' => 'Page number ', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'maxResult' => ['title' => 'Paging size, default is 20 ', 'description' => 'The number of entries per page. Default value: 20.', 'type' => 'string', 'example' => '10'], 'nextToken' => ['title' => 'nextToken ', 'description' => 'The token to retrieve the next page of results. If this parameter is empty, all results have been returned.', 'type' => 'string', 'example' => 'None'], 'pageSize' => ['title' => 'Quantity per page ', 'description' => 'The number of conversations on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '[]', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": [{"id": 1, "title": "测试对话"}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve session list', 'summary' => 'Conversation management/Conversation list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryConversationList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n ],\\n \\"total\\": 100,\\n \\"page\\": 1,\\n \\"maxResult\\": \\"10\\",\\n \\"nextToken\\": \\"None\\",\\n \\"pageSize\\": 10\\n }\\n}","type":"json"}]', ], 'ModelRouterQueryCostModelDetail' => [ 'summary' => 'billing management / Model details', 'path' => '/api/v1/modelRouter/open/billing/cost/model-detail', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Start Time, UNIX timestamp (seconds)', 'description' => 'The start of the time range to query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'End Time, UNIX timestamp (seconds)', 'description' => 'The end of the time range to query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Department ID filter ', 'description' => 'The department ID by which to filter results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'description' => ''], ], [ 'name' => 'page', 'in' => 'query', 'schema' => ['title' => 'Page number, default is 1', 'description' => 'The page number. This parameter is part of an older pagination method. For better performance and consistency, use `maxResults` and `nextToken` instead.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page, default is 20', 'description' => 'The page size. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number (preferred)', 'description' => 'The page number. This parameter is part of an older pagination method. For better performance and consistency, use `maxResults` and `nextToken` instead.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per page. This parameter is recommended for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results. Obtain this token from the `nextToken` field in a previous response.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiSingleResponse\\', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the request succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message code ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object.', '$ref' => '#/components/schemas/CostModelDetailRespDTO', 'example' => '[]'], 'maxResults' => ['description' => 'The maximum number of results returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'nextToken' => ['description' => 'The token for the next page of results. If this field is empty, you have reached the end of the results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"model_id": 1, "model_name": "qwen-plus", "granularity": "hourly", "total": 24, "page": 1, "page_size": 20, "columns": [], "rows": []},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve Model Usage Details ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostModelDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"columns\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"granularity\\": \\"hourly\\",\\n \\"modelId\\": 1,\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"rows\\": [\\n {\\n \\"timestamp\\": 1700000000,\\n \\"values\\": \\"\\\\\\"{\\\\\\\\\\\\\\"total_calls\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\"video_duration\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"total_amount\\\\\\\\\\\\\\":0.6,\\\\\\\\\\\\\\"image_count\\\\\\\\\\\\\\":3,\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\":1776787200}\\\\\\"\\"\\n }\\n ],\\n \\"total\\": 100\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterQueryCostModelList' => [ 'summary' => 'billing management / Retrieves a list of invoked models', 'path' => '/api/v1/modelRouter/open/billing/cost/models', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Start Time, UNIX timestamp (seconds) ', 'description' => 'The query\'s start time, specified as a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'End Time, UNIX timestamp (seconds) ', 'description' => 'The query\'s end time, specified as a UNIX timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'], ], [ 'name' => 'modelTypes', 'in' => 'query', 'schema' => ['title' => 'Model types, comma-separated ', 'description' => 'The model types to query. Separate multiple types with a comma.', 'type' => 'string', 'example' => 'LLM,VL', 'required' => false], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Filter by department ID', 'description' => 'The department ID to filter the results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'description' => ''], ], [ 'name' => 'granularity', 'in' => 'query', 'schema' => ['title' => 'granularity: hourly/daily, default hourly ', 'description' => 'The time granularity for data aggregation. Valid values: `hourly` and `daily`. Default value: `hourly`.', 'type' => 'string', 'example' => 'hourly', 'required' => false], ], [ 'name' => 'search', 'in' => 'query', 'schema' => ['title' => 'Fuzzy search by model name or code', 'description' => 'A keyword for a fuzzy search on the model name or model code.', 'type' => 'string', 'example' => 'qwen', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'A token from a previous response used to retrieve the next page of results.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object', 'description' => 'The data object.', '$ref' => '#/components/schemas/CostQueryModelsDTO', 'example' => '[]'], 'maxResults' => ['description' => 'The number of results returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'nextToken' => ['description' => 'The token for retrieving the next page of results. If this parameter is not returned, all results have been returned.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"columns": [], "id_field": "model_id", "name_field": "model_name", "rows": []},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve Model Usage List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostModelList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"columns\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"idField\\": \\"model_id\\",\\n \\"nameField\\": \\"model_name\\",\\n \\"rows\\": [\\n {\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelId\\": 1,\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"values\\": \\"\\\\\\"{\\\\\\\\\\\\\\"total_calls\\\\\\\\\\\\\\":21,\\\\\\\\\\\\\\"video_duration\\\\\\\\\\\\\\":210,\\\\\\\\\\\\\\"total_amount\\\\\\\\\\\\\\":126,\\\\\\\\\\\\\\"image_count\\\\\\\\\\\\\\":0}\\\\\\"\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterQueryCostOverviewMetrics' => [ 'path' => '/api/v1/modelRouter/open/billing/cost/overview', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Start Time, UNIX timestamp (seconds) ', 'description' => 'The start time for the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'End Time, UNIX timestamp (seconds) ', 'description' => 'The end time for the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'], ], [ 'name' => 'modelTypes', 'in' => 'query', 'schema' => ['title' => 'Model types, comma-separated ', 'description' => 'The model types to query. Separate multiple types with commas.', 'type' => 'string', 'example' => 'LLM,VL', 'required' => false], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Department ID filter ', 'description' => 'The department ID used to filter the results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100', 'description' => '', 'title' => ''], ], [ 'name' => 'granularity', 'in' => 'query', 'schema' => ['title' => 'Granularity: hourly/daily, default hourly ', 'description' => 'The granularity of the data. Valid values: `hourly` and `daily`. Default value: `hourly`.', 'type' => 'string', 'example' => 'hourly', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return in a single request.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The token to retrieve the next page of results. If you do not specify this parameter, the first page of results is returned.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiSingleResponse\\', 'title' => 'OpenApiSingleResponse> ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The data object that contains the returned metrics.', 'title' => 'Data object ', 'type' => 'array', 'items' => ['description' => 'The data structure of a returned result.', '$ref' => '#/components/schemas/MetricValueDTO', 'example' => '[]', 'title' => ''], 'example' => '[]', ], 'maxResults' => ['description' => 'The maximum number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": [{"key": "total_calls", "label": "调用次数", "unit": "次", "value": 100}],'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Obtain Usage Overview Metrics ', 'summary' => 'billing management / Get cost overview metrics', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostOverviewMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"unit\\": \\"次\\",\\n \\"value\\": 100\\n }\\n ],\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterQueryCostTrendMetrics' => [ 'summary' => 'billing management / Cost trends', 'path' => '/api/v1/modelRouter/open/billing/cost/trend', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Start Time, UNIX timestamp (seconds) ', 'description' => 'The start time of the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'End Time, UNIX timestamp (seconds) ', 'description' => 'The end time of the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'], ], [ 'name' => 'modelTypes', 'in' => 'query', 'schema' => ['title' => 'Model types, comma-separated ', 'description' => 'The model types to query, separated by commas.', 'type' => 'string', 'example' => 'LLM,VL', 'required' => false], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Department ID filter ', 'description' => 'Filters the results by department ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => '', 'description' => ''], ], [ 'name' => 'granularity', 'in' => 'query', 'schema' => ['title' => 'Granularity: hourly/daily, default is hourly ', 'description' => 'The granularity of the data. Valid values: `hourly` and `daily`. Default: `hourly`.', 'type' => 'string', 'example' => 'hourly', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token from a previous response to retrieve the next page of results. If this parameter is omitted, the first page of results is returned.', 'type' => 'string', 'required' => false, 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response body.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique request ID. If you encounter a problem, provide this ID to technical support for troubleshooting.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful. A value of `true` indicates success, and `false` indicates failure.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object containing the cost trend metrics.', '$ref' => '#/components/schemas/CostQueryTrendDTO', 'example' => '[]'], 'maxResults' => ['description' => 'The maximum number of results returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], 'nextToken' => ['description' => 'A token to retrieve the next page of results. If no token is returned, all results have been retrieved.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"default_metric": "total_amount", "granularity": "hourly", "metrics": [], "points": []},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve Usage Trend ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostTrendMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"defaultMetric\\": \\"total_amount\\",\\n \\"granularity\\": \\"hourly\\",\\n \\"metrics\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"label\\": \\"调用次数\\",\\n \\"sortable\\": true,\\n \\"unit\\": \\"次\\"\\n }\\n ],\\n \\"points\\": [\\n {\\n \\"timestamp\\": 1700000000,\\n \\"values\\": \\"\\\\\\"{\\\\\\\\\\\\\\"total_calls\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"video_duration\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"total_amount\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"model_count\\\\\\\\\\\\\\":0,\\\\\\\\\\\\\\"image_count\\\\\\\\\\\\\\":0}\\\\\\"\\"\\n }\\n ]\\n },\\n \\"maxResults\\": 10,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterQueryModel' => [ 'summary' => 'Retrieves details for a specific model.', 'path' => '/api/v1/modelRouter/open/models/{id}', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Success status ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error code ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object.', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "gpt-4", "type": "chat"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve Model Information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterQueryModelList' => [ 'path' => '/api/v1/modelRouter/open/models', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page ', 'description' => 'The number of models to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number ', 'description' => 'The page number to retrieve. Pages are numbered starting from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field ', 'description' => 'The field to use for sorting the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction ', 'description' => 'The sort order. Valid values include `ASC` for ascending order and `DESC` for descending order.', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'Grouping field ', 'description' => 'The field to use for grouping the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required ', 'description' => 'Specifies whether to include the total count of matching models in the response.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results ', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'keyword', 'in' => 'query', 'schema' => ['title' => 'Search keyword ', 'description' => 'The keyword for a fuzzy search on model information.', 'type' => 'string', 'example' => 'test', 'required' => false], ], [ 'name' => 'status', 'in' => 'query', 'schema' => ['title' => 'Status Filter', 'description' => 'The model status to use as a filter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token for retrieving the next page of results. If this parameter is not specified, the first page is retrieved. To retrieve a subsequent page, set this to the `nextToken` value from the previous response.', 'type' => 'string', 'example' => '1', 'required' => false, 'title' => ''], ], [ 'name' => 'modelType', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'Chat', 'description' => '', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'A paginated response containing a list of models.', 'title' => 'OpenApiPageResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique identifier for the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code. Returned only when the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message. Returned only when the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'Contains the paginated list of models and pagination metadata.', 'title' => 'Data object ', 'type' => 'object', 'items' => ['description' => '返回数据对象', 'extendType' => 'true', '$ref' => '#/components/schemas/ModelDTO'], 'example' => '[]', 'properties' => [ 'list' => [ 'type' => 'array', 'items' => ['description' => 'A model object.', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO', 'title' => ''], 'description' => 'An array of model objects.', 'title' => '', 'example' => '', ], 'total' => ['description' => 'The total number of models that meet the filter criteria.', 'type' => 'string', 'example' => '5', 'title' => ''], 'page' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'pageSize' => ['description' => 'The number of models per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], 'nextToken' => ['description' => 'The pagination token used to retrieve the next page of results. An empty value indicates that no more results are available.', 'type' => 'string', 'example' => 'None', 'title' => ''], 'maxResults' => ['description' => 'The maximum number of results per page.', 'type' => 'string', 'example' => 'None', 'title' => ''], ], ], 'maxResults' => ['title' => 'maxResults ', 'description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": [{"id": 1, "name": "gpt-4", "type": "chat"}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve Model List ', 'summary' => 'Model management/Get model list', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryModelList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n ],\\n \\"total\\": \\"5\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 1,\\n \\"nextToken\\": \\"None\\",\\n \\"maxResults\\": \\"None\\"\\n },\\n \\"maxResults\\": 10\\n}","type":"json"}]', ], 'ModelRouterQueryNacosProviders' => [ 'summary' => 'Configures Nacos or retrieves the list of Nacos service providers.', 'path' => '/api/v1/modelRouter/open/nacos/providers', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field by which to sort the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The sort direction.', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The field by which to group the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'Specifies whether to return the total count.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The pagination token for the next page.', 'type' => 'string', 'example' => '1', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => '', 'description' => 'OpenApiPageResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => '', 'description' => 'The error message code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'array', 'items' => [ 'description' => 'The returned data object.', 'type' => 'object', 'properties' => [ 'name' => ['title' => '', 'description' => 'The provider name.', 'type' => 'string', 'example' => '通义千问'], 'symbol' => ['title' => '', 'description' => 'The provider identifier.', 'type' => 'string', 'example' => 'qwen'], 'baseUrl' => ['title' => '', 'description' => 'The base URL.', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com'], 'models' => [ 'title' => '', 'description' => 'The list of models.', 'type' => 'array', 'items' => [ 'description' => 'The model object.', 'type' => 'object', 'properties' => [ 'identifier' => ['title' => '', 'description' => 'The model identifier.', 'type' => 'string', 'example' => 'ca90f359956e94367470c38676'], 'inputToken' => ['title' => '', 'description' => 'The input token limit.', 'type' => 'string', 'example' => '32K'], 'outputToken' => ['title' => '', 'description' => 'The output token limit.', 'type' => 'string', 'example' => '8K'], 'inOut' => ['title' => '', 'type' => 'string', 'example' => 'text', 'description' => ''], 'type' => ['title' => '', 'type' => 'string', 'example' => 'Chat', 'description' => ''], 'extensions' => [ 'title' => '', 'type' => 'object', 'properties' => [ 'async' => ['title' => '', 'type' => 'boolean', 'description' => '', 'example' => ''], ], 'description' => '', 'example' => '', ], ], 'title' => '', 'example' => '', ], 'example' => '', ], ], 'example' => '[]', 'title' => '', ], 'example' => '[]', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 2,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": ["provider1", "provider2"]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve model identity information', 'description' => 'This operation is deprecated. Do not use it.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryNacosProviders', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"name\\": \\"通义千问\\",\\n \\"symbol\\": \\"qwen\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"models\\": [\\n {\\n \\"identifier\\": \\"ca90f359956e94367470c38676\\",\\n \\"inputToken\\": \\"32K\\",\\n \\"outputToken\\": \\"8K\\",\\n \\"inOut\\": \\"text\\",\\n \\"type\\": \\"Chat\\",\\n \\"extensions\\": {\\n \\"async\\": false\\n }\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', ], 'ModelRouterQueryNacosTags' => [ 'summary' => 'Retrieves a list of tags from Nacos.', 'path' => '/api/v1/modelRouter/open/nacos/tags', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page', 'description' => 'The number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field', 'description' => 'The field by which to sort the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction', 'description' => 'The sort order.', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'Grouping field', 'description' => 'The field by which to group the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required', 'description' => 'Specifies whether to return the total count of results.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => 'nextToken', 'description' => 'The token from a previous response to retrieve the next page of results.', 'type' => 'string', 'example' => '1', 'required' => false], ], [ 'name' => 'configType', 'in' => 'query', 'schema' => ['type' => 'string', 'example' => 'providers', 'title' => '', 'description' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiPageResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded.', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'An array of tags.', 'title' => 'Data object', 'type' => 'array', 'items' => [ 'description' => 'The properties of a single tag.', 'title' => 'Data object', 'type' => 'object', 'properties' => [ 'tagName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'tag' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'value' => ['type' => 'string', 'example' => 'NLP', 'description' => '', 'title' => ''], 'label' => ['type' => 'string', 'example' => '文本生成', 'description' => '', 'title' => ''], ], 'example' => '[]', ], 'example' => '[]', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 2,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": ["tag1", "tag2"]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Retrieve model label information', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryNacosTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"tagName\\": \\"\\",\\n \\"tag\\": \\"\\",\\n \\"value\\": \\"NLP\\",\\n \\"label\\": \\"文本生成\\"\\n }\\n ]\\n}","type":"json"}]', ], 'ModelRouterQueryObservationCharts' => [ 'path' => '/api/v1/modelRouter/open/observation/charts', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Customer ID filter ', 'description' => 'The client ID to use as a filter.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['title' => 'API key ID filter ', 'description' => 'The API key ID to use as a filter.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['title' => 'Model ID filter ', 'description' => 'The model ID to use as a filter.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'timeRange', 'in' => 'query', 'schema' => ['title' => 'Time Range (1h, 6h, 24h, 7d, 30d) ', 'description' => 'The time range for the query. Valid values are `1h`, `6h`, `24h`, `7d`, and `30d`. This parameter is mutually exclusive with `startTime` and `endTime`.', 'type' => 'string', 'example' => '24h', 'required' => false], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Custom start time ', 'description' => 'The start time of the custom time range, in ISO 8601 UTC format. If specified, `endTime` must also be provided.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'required' => false], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'Custom End Time ', 'description' => 'The end time of the custom time range, in ISO 8601 UTC format. If specified, `startTime` must also be provided.', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code of the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data returned for the request.', 'example' => '[]', '$ref' => '#/components/schemas/ObservationChartsDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"requestCount": 100, "tokenCount": 5000},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'View API real-time monitoring data ', 'summary' => 'Retrieves chart data for model observation.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryObservationCharts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"qpm\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"tpm\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"concurrency\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"callVolume\\": [],\\n \\"successRate\\": [\\n {\\n \\"timestamp\\": \\"2024-01-01T00:00:00Z\\",\\n \\"value\\": \\"\\",\\n \\"label\\": \\"series1\\"\\n }\\n ],\\n \\"responseTime\\": []\\n }\\n}","type":"json"}]', ], 'ModelRouterQueryObservationLogs' => [ 'summary' => 'Model Observation / Observation Logs', 'path' => '/api/v1/modelRouter/open/observation/logs', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Quantity per page ', 'description' => 'The number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page index ', 'description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field ', 'description' => 'The sort field.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction ', 'description' => 'The sort direction.', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'Grouping field ', 'description' => 'The grouping field.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required ', 'description' => 'Specifies whether to return the total count of results.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results ', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Customer ID filter ', 'description' => 'Filters the results by client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['title' => 'API key ID filter ', 'description' => 'Filters the results by API key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['title' => 'Model ID filter ', 'description' => 'Filters the results by model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'timeRange', 'in' => 'query', 'schema' => ['title' => 'Time range (1h, 6h, 24h, 7d, 30d) ', 'description' => 'The time range for the query. Valid values are `1h`, `6h`, `24h`, `7d`, and `30d`.', 'type' => 'string', 'example' => '24h', 'required' => false], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Custom start time ', 'description' => 'The start time for a custom time range.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'required' => false], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'Custom end time ', 'description' => 'The end time for a custom time range.', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The pagination token from a previous response to retrieve the next page of results.', 'type' => 'string', 'example' => '1', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiPageResponse', 'title' => 'OpenApiPageResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code for a failed request.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message for a failed request.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The response payload.', 'title' => 'Data object ', 'type' => 'object', 'items' => ['description' => '返回数据', 'extendType' => 'true', '$ref' => '#/components/schemas/RequestLogDTO'], '$ref' => '#/components/schemas/RequestLogDTO ', 'example' => '[]', 'properties' => [ 'list' => [ 'type' => 'array', 'items' => ['$ref' => '#/components/schemas/RequestLogDTO', 'description' => '', 'title' => '', 'example' => ''], 'description' => '', 'title' => '', 'example' => '', ], 'total' => ['type' => 'integer', 'format' => 'int32', 'example' => 'None', 'description' => '', 'title' => ''], 'page' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], 'pageSize' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], 'nextToken' => ['type' => 'integer', 'format' => 'int32', 'example' => '0', 'description' => '', 'title' => ''], 'maxResults' => ['type' => 'integer', 'format' => 'int32', 'example' => '1', 'description' => '', 'title' => ''], ], ], 'nextToken' => ['description' => 'The token to retrieve the next page of results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx', 'title' => ''], 'maxResults' => ['description' => 'The maximum number of results per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": [{"id": 1, "requestId": "req-xxx"}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'View API invocation records ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryObservationLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"list\\": [\\n {\\n \\"id\\": 1,\\n \\"requestId\\": \\"req-xxxx\\",\\n \\"clientId\\": 1,\\n \\"apiKeyId\\": 1,\\n \\"modelId\\": 1,\\n \\"modelName\\": \\"通义千问\\",\\n \\"requestTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"responseTimeMs\\": 100,\\n \\"statusCode\\": 200,\\n \\"promptTokens\\": 100,\\n \\"completionTokens\\": 50,\\n \\"totalTokens\\": 150,\\n \\"requestBody\\": \\"{}\\",\\n \\"responseBody\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"modelCode\\": \\"qwen3-max\\",\\n \\"symbol\\": \\"qwen\\",\\n \\"clientUuid\\": \\"mt_xxxxxMYTX9\\",\\n \\"status\\": \\"success\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"usage\\": {\\n \\"promptTokens\\": 100,\\n \\"completionTokens\\": 50,\\n \\"totalTokens\\": 150,\\n \\"imageCount\\": 0,\\n \\"videoCount\\": 0,\\n \\"videoDuration\\": 0\\n }\\n }\\n ],\\n \\"total\\": 0,\\n \\"page\\": 1,\\n \\"pageSize\\": 1,\\n \\"nextToken\\": 0,\\n \\"maxResults\\": 1\\n },\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\",\\n \\"maxResults\\": 10\\n}","type":"json"}]', ], 'ModelRouterQueryObservationMetrics' => [ 'path' => '/api/v1/modelRouter/open/observation/metrics', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => 'Number of items per page ', 'description' => 'The number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'required' => false], ], [ 'name' => 'pageIndex', 'in' => 'query', 'schema' => ['title' => 'Page number ', 'description' => 'The page number to retrieve.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false], ], [ 'name' => 'orderBy', 'in' => 'query', 'schema' => ['title' => 'Sorting field ', 'description' => 'The field to use for sorting the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'orderDirection', 'in' => 'query', 'schema' => ['title' => 'Sorting direction', 'description' => 'The sort order. Valid values: `ASC` (ascending) and `DESC` (descending).', 'type' => 'string', 'example' => 'DESC', 'default' => 'DESC', 'required' => false], ], [ 'name' => 'groupBy', 'in' => 'query', 'schema' => ['title' => 'Grouping field ', 'description' => 'The field to use for grouping the results.', 'type' => 'string', 'example' => 'resourceId', 'required' => false], ], [ 'name' => 'needTotalCount', 'in' => 'query', 'schema' => ['title' => 'Indicates whether the total count is required ', 'description' => 'Specifies whether to return the total count of results.', 'type' => 'boolean', 'example' => 'true', 'default' => 'true', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => 'Maximum number of results', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '0', 'required' => false], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['title' => 'Customer ID filter ', 'description' => 'The client ID to use for filtering the results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['title' => 'API key ID filter ', 'description' => 'The API Key ID to use for filtering the results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['title' => 'Model ID filter ', 'description' => 'The model ID to use for filtering the results.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'timeRange', 'in' => 'query', 'schema' => ['title' => 'Time Range (1h, 6h, 24h, 7d, 30d)', 'description' => 'The time range for the query. Valid values: `1h`, `6h`, `24h`, `7d`, and `30d`.', 'type' => 'string', 'example' => '24h', 'required' => false], ], [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => 'Custom start time', 'description' => 'The start time of a custom time range for the query.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'required' => false], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => 'Custom end time', 'description' => 'The end time of a custom time range for the query.', 'type' => 'string', 'example' => '2024-01-02T00:00:00Z', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['description' => 'The token used to retrieve the next page of results, obtained from the previous response.', 'type' => 'string', 'example' => '2', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response wrapper object.', 'title' => 'OpenApiPageResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned on failure.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message returned on failure.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'An object that contains the results and pagination information.', 'title' => 'Data object ', 'type' => 'array', 'items' => ['description' => 'A data object containing metrics for a single model.', '$ref' => '#/components/schemas/ModelMetricsDTO', 'title' => '', 'example' => ''], 'example' => '[]', '$ref' => '#/components/schemas/ModelMetricsDTO', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "total": 1,'."\n" .' "page": 1,'."\n" .' "pageSize": 10,'."\n" .' "list": [{"modelId": 1, "modelName": "gpt-4", "callCount": 100}]'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'View API call report type information ', 'summary' => 'Model Observation > Get Observation Metric Data', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryObservationMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": [\\n {\\n \\"totalCalls\\": 1000,\\n \\"successRate\\": 99.5,\\n \\"avgResponseTime\\": 200.5,\\n \\"inputTokens\\": 500000,\\n \\"outputTokens\\": 300000\\n }\\n ]\\n}","type":"json"}]', ], 'ModelRouterQueryUsageBreakdown' => [ 'summary' => 'Usage management / Query usage breakdown', 'path' => '/api/v1/modelRouter/open/usage/breakdown', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'startTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The start time for the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700000000'], ], [ 'name' => 'endTime', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The end time for the query, specified as a Unix timestamp in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1700086400'], ], [ 'name' => 'granularity', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The granularity of aggregation. Valid values: `hourly` or `daily`.', 'type' => 'string', 'required' => true, 'example' => 'hourly'], ], [ 'name' => 'clientId', 'in' => 'query', 'schema' => ['description' => 'The client ID. Use this parameter to query usage data for a specific client.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], [ 'name' => 'apiKeyId', 'in' => 'query', 'schema' => ['description' => 'The ID of the API key. Use this parameter to query usage data for a specific API key.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], ], [ 'name' => 'page', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], [ 'name' => 'pageSize', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The page size. Default: 20. Maximum: 500.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'maxResults', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'required' => false], ], [ 'name' => 'nextToken', 'in' => 'query', 'schema' => ['title' => '', 'description' => 'The pagination token used to retrieve the next page of results.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'."\n", 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => '', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => '', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => '', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => '', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => '', 'description' => 'The data object.', 'example' => '{}', '$ref' => '#/components/schemas/UsageBreakdownRespDTO'], 'maxResults' => ['title' => '', 'description' => 'The maximum number of results to return.', 'type' => 'integer', 'format' => 'int32', 'example' => '20'], 'nextToken' => ['title' => '', 'description' => 'The pagination token. The response includes this token when there are more results to retrieve.', 'type' => 'string', 'example' => 'xxxx-xxx-xxxxx'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"granularity": "hourly", "total": 100, "page": 1, "page_size": 20, "rows": []},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => '组织不存在，请主账号开通权限后再试，或联系管理员', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Batch Query Usage Details ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryUsageBreakdown', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"granularity\\": \\"hourly\\",\\n \\"page\\": 1,\\n \\"pageSize\\": 20,\\n \\"total\\": 100,\\n \\"rows\\": [\\n {\\n \\"summaryTime\\": 1700000000,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问-Plus\\",\\n \\"modelType\\": \\"llm\\",\\n \\"clientId\\": 0,\\n \\"clientName\\": \\"研发部\\",\\n \\"apiKeyId\\": 0,\\n \\"apiKeyName\\": \\"默认密钥\\",\\n \\"metrics\\": [\\n {\\n \\"key\\": \\"total_calls\\",\\n \\"value\\": 100\\n }\\n ]\\n }\\n ]\\n },\\n \\"maxResults\\": 20,\\n \\"nextToken\\": \\"xxxx-xxx-xxxxx\\"\\n}","type":"json"}]', ], 'ModelRouterSaveFlowConfig' => [ 'path' => '/api/v1/modelRouter/open/flow-config', 'methods' => ['post'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'title' => 'Throttle configuration write request', 'type' => 'object', 'properties' => [ 'modelId' => ['title' => 'Model ID', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '607'], 'smoothFlowEnabled' => ['title' => 'Is smoothing throttle enabled', 'description' => 'Specifies whether to enable smooth flow control.', 'type' => 'boolean', 'example' => 'true'], 'rpm' => ['title' => 'Requests per minute limit (RPM)', 'description' => 'The maximum number of requests per minute (RPM).', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'tpm' => ['title' => 'Tokens per minute limit (TPM)', 'description' => 'The maximum number of tokens per minute (TPM).', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], ], 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Is Succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error Message Encoding ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error Message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP Status Code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The data returned.', 'title' => 'Returned Data ', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Throttle Configuration ID ', 'description' => 'The ID of the flow control configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '6'], 'modelId' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '607'], 'smoothFlowEnabled' => ['title' => 'Is Smoothing Throttle Enabled ', 'description' => 'Indicates whether smooth flow control is enabled.', 'type' => 'boolean', 'example' => 'true'], 'rpm' => ['title' => 'Requests Per Minute Limit (RPM) ', 'description' => 'The configured RPM.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'], 'tpm' => ['title' => 'Tokens Per Minute Limit (TPM) ', 'description' => 'The configured TPM.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000'], 'gmtCreate' => ['title' => 'Creation Time ', 'description' => 'The creation time of the configuration.', 'type' => 'string', 'example' => '2026-04-27T18:28:57.987356+08:00'], 'gmtModified' => ['title' => 'Updated At ', 'description' => 'The last modification time of the configuration.', 'type' => 'string', 'example' => '2026-04-27T18:28:57.987356+08:00'], ], 'example' => '', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {'."\n" .' "id": 6,'."\n" .' "model_id": 607,'."\n" .' "smooth_flow_enabled": true,'."\n" .' "rpm": 100,'."\n" .' "tpm": 10000,'."\n" .' "gmt_create": "2026-04-27T18:28:57.987356+08:00",'."\n" .' "gmt_modified": "2026-04-27T18:28:57.987356+08:00"'."\n" .' },'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 200 => [ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''], ], 403 => [ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => 'Authentication failed-Organization does not exist'], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'summary' => 'Flow control management / Save flow control configuration', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterSaveFlowConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 6,\\n \\"modelId\\": 607,\\n \\"smoothFlowEnabled\\": true,\\n \\"rpm\\": 100,\\n \\"tpm\\": 10000,\\n \\"gmtCreate\\": \\"2026-04-27T18:28:57.987356+08:00\\",\\n \\"gmtModified\\": \\"2026-04-27T18:28:57.987356+08:00\\"\\n }\\n}","type":"json"}]', 'title' => 'ModelRouterSaveFlowConfig', ], 'ModelRouterUpdateBillingRule' => [ 'path' => '/api/v1/modelRouter/open/billing/rules/{id}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Billing Rule ID', 'description' => 'The ID of the billing rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body for updating a billing rule.', 'title' => 'Billing Rule Update Request', 'type' => 'object', 'properties' => [ 'billingType' => ['title' => 'Billing type ', 'description' => 'The billing type. Must be `configurable`.', 'type' => 'string', 'example' => 'configurable', 'required' => false], 'pricingConfig' => ['title' => 'Billing configuration JSON ', 'description' => 'The billing configuration, specified as a JSON object.'."\n" ."\n" .'1. **Token-based tiered pricing (`token_tiered`)**
Applies to `Chat` models. Billing is tiered based on the token count, with separate rates for standard mode, thinking mode, and cache hits. The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "tiers": \\['."\n" .' {'."\n" .' "min\\_tokens": 0,'."\n" .' "max\\_tokens": 32000,'."\n" .' "input\\_price": 2.5,'."\n" .' "output\\_price": 10,'."\n" .' "thinking\\_input\\_price": 2.5,'."\n" .' "thinking\\_output\\_price": 10,'."\n" .' "cached\\_input\\_price": 2.5'."\n" .' },'."\n" .' {'."\n" .' "min\\_tokens": 32000,'."\n" .' "max\\_tokens": 128000,'."\n" .' "input\\_price": 4,'."\n" .' "output\\_price": 16,'."\n" .' "thinking\\_input\\_price": 4,'."\n" .' "thinking\\_output\\_price": 16,'."\n" .' "cached\\_input\\_price": 4'."\n" .' }'."\n" .' ]'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `tiers` | array | Yes | A required array of tiered pricing objects. | -
'."\n" .' `tiers[].min_tokens` | integer | Yes | The lower bound (inclusive) of the token count for the current tier. | token
'."\n" .' `tiers[].max_tokens` | integer | Yes | The upper bound (exclusive) of the token count for the current tier. A value of 0 indicates no upper limit. | token
'."\n" .' `tiers[].input_price` | number | Yes | The unit price for input tokens in standard mode. | CNY / million tokens
'."\n" .' `tiers[].output_price` | number | Yes | The unit price for output tokens in standard mode. | CNY / million tokens
'."\n" .' `tiers[].thinking_input_price` | number | No | The unit price for input tokens in thinking mode. | CNY / million tokens
'."\n" .' `tiers[].thinking_output_price` | number | No | The unit price for output tokens in thinking mode. | CNY / million tokens
'."\n" .' `tiers[].cached_input_price` | number | No | The unit price for input tokens on a cache hit. | CNY / million tokens
'."\n" .' `thinking_mode_tiers` | array | No | Dedicated tiers for thinking mode. The structure is the same as `tiers`. If a request includes a `reasoning_tokens` field and this array is not empty, this array overrides the default `tiers`. | -
'."\n" .' **Constraints:**













'."\n" ."\n" .'2. **Per-image billing (`per_image`)**
Applies to `ImageGeneration` and `ImageEdit` models. Billing is based on the number of images generated or processed. The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "price\\_per\\_image": 0.2'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `price_per_image` | number | Yes | The unit price per image. | CNY / image




'."\n" ."\n" .'3. **Video matrix billing (`video_matrix`)**
Applies to `VideoGeneration` and `VideoImageGeneration` models. Pricing is based on a combination of video resolution and the presence of audio.
'."\n" .' **Note:** The server automatically converts the `matrix` field, used by the frontend UI, to the `tiers` field required by the API.
'."\n" .' The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "tiers": \\['."\n" .' {'."\n" .' "resolution": 480,'."\n" .' "has\\_audio": 0,'."\n" .' "price\\_per\\_second": 0.24'."\n" .' },'."\n" .' {'."\n" .' "resolution": 480,'."\n" .' "has\\_audio": 1,'."\n" .' "price\\_per\\_second": 0.24'."\n" .' },'."\n" .' {'."\n" .' "resolution": 720,'."\n" .' "has\\_audio": 0,'."\n" .' "price\\_per\\_second": 0.24'."\n" .' },'."\n" .' {'."\n" .' "resolution": 720,'."\n" .' "has\\_audio": 1,'."\n" .' "price\\_per\\_second": 0.24'."\n" .' }'."\n" .' ],'."\n" .' "default\\_price\\_per\\_second": 0.24'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `tiers` | array | Yes | An array of video matrix pricing objects. | -
'."\n" .' `tiers[].resolution` | integer | Yes | The video resolution. Valid values: 480, 720, and 1080. | Pixel height (p)
'."\n" .' `tiers[].has_audio` | integer | Yes | Indicates whether audio is included. Valid values: 0 (no audio) and 1 (with audio). | -
'."\n" .' `tiers[].price_per_second` | number | Yes | The unit price per second for this combination. | CNY / second
'."\n" .' `default_price_per_second` | number | No | The default unit price per second, applied if the request\'s parameters do not match any item in the `tiers` array. | CNY / second
'."\n" .' **Constraints:**











'."\n" ."\n" .'4. **Per-duration billing (`per_duration`)**
Applies to speech recognition (ASR) models. Billing is based on the duration of the audio. The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "price\\_per\\_unit": 0.00022'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `price_per_unit` | number | Yes | The unit price per second of audio. | CNY / second




'."\n" ."\n" .'5. **Per-character billing (`per_character`)**
Applies to speech synthesis (TTS) models. Billing is based on the number of characters in the synthesized text. The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "price\\_per\\_unit": 0.8'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `price_per_unit` | number | Yes | The unit price per 10,000 characters. | CNY / 10,000 characters




'."\n" ."\n" .'6. **Flat-rate token billing (`token_flat`)**
Applies to `Embedding`, `Rerank`, `MultimodalEmbedding`, and `MultimodalRerank` models. This method uses a single unit price without tiers. The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "input\\_price": 0.5,'."\n" .' "multimodal\\_input\\_price": 0.5'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `input_price` | number | Yes | The unit price for text-only input tokens. | CNY / million tokens
'."\n" .' `multimodal_input_price` | number | No | The unit price for multimodal input tokens. | CNY / million tokens





'."\n" ."\n" .'7. **Omni-modal multi-dimension billing (`omni_multimodal`)**
Applies to omni-modal models, such as `ChatFullmodal` (for example, `qwen3.5-omni-plus`). Prices are set separately for different input and output modalities, such as text, audio, images, and videos. The JSON format is as follows:
'."\n" .' json'."\n" .' {'."\n" .' "text\\_input\\_price": 7,'."\n" .' "audio\\_input\\_price": 53,'."\n" .' "image\\_input\\_price": 7,'."\n" .' "video\\_input\\_price": 7,'."\n" .' "text\\_output\\_price": 40,'."\n" .' "audio\\_output\\_price": 213,'."\n" .' "multi\\_text\\_output\\_price": 0'."\n" .' }'."\n" .' **Field descriptions:**
'."\n" .' Field | Type | Required | Description | Unit
'."\n" .' \\---|---|---|---|---
'."\n" .' `text_input_price` | number | Yes | The unit price for text input tokens. | CNY / million tokens
'."\n" .' `audio_input_price` | number | Yes | The unit price for audio input tokens. | CNY / million tokens
'."\n" .' `image_input_price` | number | No | The unit price for image input tokens. | CNY / million tokens
'."\n" .' `video_input_price` | number | No | The unit price for video input tokens. | CNY / million tokens
'."\n" .' `text_output_price` | number | Yes | The unit price for text output tokens. | CNY / million tokens
'."\n" .' `audio_output_price` | number | No | The unit price for audio output tokens. | CNY / million tokens
'."\n" .' `multi_text_output_price` | number | No | The unit price for text output tokens when the input is multimodal (contains images, audio, or video). | CNY / million tokens

'."\n" .' **Automatic billing type mapping**
'."\n" .' Model type (`model_type`) | Auto-detected billing type | Key identifying field in `pricingConfig`
'."\n" .' \\---|---|---
'."\n" .' `Chat` | `token_tiered` | The `tiers` field is present.
'."\n" .' `ChatFullmodal` | `omni_multimodal` | The `text_input_price` or `audio_input_price` field is present.
'."\n" .' `ImageGeneration` / `ImageEdit` | `per_image` | The `price_per_image` field is present.
'."\n" .' `VideoGeneration` / `VideoImageGeneration` | `video_matrix` | The `tiers` field is present, and its elements contain `resolution`.
'."\n" .' `ASR` | `per_duration` | The `price_per_unit` field is present (ASR scenario).
'."\n" .' `TTS` | `per_character` | The `price_per_unit` field is present (TTS scenario).
'."\n" .' `Embedding` / `Rerank` / `MultimodalEmbedding` / `MultimodalRerank` | `token_flat` | The `input_price` field is present.





















', 'type' => 'any', 'required' => false, 'example' => '{'."\n" .' "tiers": ['."\n" .' {'."\n" .' "min_tokens": 0,'."\n" .' "max_tokens": 32000,'."\n" .' "input_price": 2.5,'."\n" .' "output_price": 2.5,'."\n" .' "thinking_output_price": 10,'."\n" .' "cached_input_price": 1.25'."\n" .' },'."\n" .' {'."\n" .' "min_tokens": 32000,'."\n" .' "max_tokens": 0,'."\n" .' "input_price": 1.25,'."\n" .' "output_price": 1.25,'."\n" .' "thinking_output_price": 5,'."\n" .' "cached_input_price": 0.625'."\n" .' }'."\n" .' ]'."\n" .'}'], 'effectiveTime' => ['title' => 'Effective period, in RFC3339 format ', 'description' => 'The effective time, in RFC3339 format.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z', 'required' => false], 'expireTime' => ['title' => 'Time-to-live (TTL), in RFC3339 format ', 'description' => 'The expiration time, in RFC3339 format.', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z', 'required' => false], 'status' => ['title' => 'Status, used to enable or disable ', 'description' => 'The status of the billing rule. Use this field to enable or disable the rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], 'version' => ['title' => 'Billing rule version number ', 'description' => 'The version number of the billing rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Success status', 'description' => 'Indicates whether the request is successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The returned data.', 'title' => 'Returned Data ', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Rule ID', 'description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelId' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1'], 'modelCode' => ['title' => 'Model identity', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'qwen-plus'], 'modelName' => ['title' => 'Model Name', 'description' => 'The model name.', 'type' => 'string', 'example' => '通义千问Plus'], 'modelType' => ['title' => 'Model Type ', 'description' => 'The model type.', 'type' => 'string', 'example' => 'chat'], 'symbol' => ['title' => 'Vendor Identity ', 'description' => 'The vendor ID.', 'type' => 'string', 'example' => 'alibaba'], 'billingType' => ['title' => 'Billing type', 'description' => 'The billing type.', 'type' => 'string', 'example' => 'token_tiered'], 'pricingConfig' => ['title' => 'Billing configuration', 'description' => 'The billing configuration.', 'type' => 'any', 'example' => '{}'], 'effectiveTime' => ['title' => 'Effective Period ', 'description' => 'The time when the rule takes effect.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'expireTime' => ['title' => 'Time-to-live (TTL)', 'description' => 'The expiration time.', 'type' => 'string', 'example' => '2025-01-01T00:00:00Z'], 'version' => ['title' => 'Version Number ', 'description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], 'deleteTag' => ['title' => 'Delete marker', 'description' => 'The deletion tag.', 'type' => 'integer', 'format' => 'int32', 'example' => '0'], 'gmtCreate' => ['title' => 'Creation Time ', 'description' => 'The creation time.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], 'gmtModified' => ['title' => 'Updated At ', 'description' => 'The modification time.', 'type' => 'string', 'example' => '2024-01-01T00:00:00Z'], ], 'example' => '', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "billing_type": "token_tiered"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 200 => [ ['errorCode' => 'B.Resource.NotFoundException', 'errorMessage' => 'B.Resource.NotFoundException.', 'description' => ''], ['errorCode' => 'B.Billing.RuleNotFoundException', 'errorMessage' => 'B.Billing.RuleNotFoundException.', 'description' => ''], ], 403 => [ ['errorCode' => 'B.Permission.OrgNoExistException', 'errorMessage' => 'B.Permission .OrgNoExistException.', 'description' => 'Authentication failed-Organization does not exist'], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Billing Management / Update Billing Rule', 'summary' => 'Billing management/Update billing rules', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateBillingRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"modelId\\": 1,\\n \\"modelCode\\": \\"qwen-plus\\",\\n \\"modelName\\": \\"通义千问Plus\\",\\n \\"modelType\\": \\"chat\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"billingType\\": \\"token_tiered\\",\\n \\"pricingConfig\\": \\"{}\\",\\n \\"effectiveTime\\": \\"2024-01-01T00:00:00Z\\",\\n \\"expireTime\\": \\"2025-01-01T00:00:00Z\\",\\n \\"version\\": 1,\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterUpdateClient' => [ 'path' => '/api/v1/modelRouter/open/clients/{id}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Customer ID ', 'description' => 'The client ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'title' => 'Request data structure ', 'properties' => [ 'name' => ['title' => 'Customer Name ', 'description' => 'The client name.', 'type' => 'string', 'example' => '我的客户', 'required' => false], 'address' => ['title' => 'Company address ', 'description' => 'The company address.', 'type' => 'string', 'example' => '杭州市', 'required' => false], 'contact' => ['title' => 'Contact Information ', 'description' => 'The contact information.', 'type' => 'string', 'example' => '13800138000', 'required' => false], 'remark' => ['title' => 'Remarks ', 'description' => 'A remark about the client.', 'type' => 'string', 'example' => '备注', 'required' => false], 'discount' => ['type' => 'number', 'format' => 'double', 'example' => '1.0', 'description' => '', 'title' => ''], 'status' => ['title' => 'Status ', 'description' => 'The client\'s status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], 'allowedModels' => ['title' => 'Comma-separated list of allowed model IDs; empty indicates all models ', 'description' => 'A comma-separated list of model IDs that the client can use. If this parameter is left empty, the client can use all models.', 'type' => 'string', 'example' => '1,2,3', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'OpenApiSingleResponse', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The returned data object.', 'example' => '[]', '$ref' => '#/components/schemas/ClientDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "更新后客户"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Update Customer Information ', 'summary' => 'Updates a specified client\'s information.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"我的客户\\",\\n \\"address\\": \\"杭州市\\",\\n \\"contact\\": \\"13800138000\\",\\n \\"main\\": 0,\\n \\"remark\\": \\"备注\\",\\n \\"clientUuid\\": \\"st-xxxx\\",\\n \\"allowedModels\\": \\"1,2,3\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterUpdateConversation' => [ 'path' => '/api/v1/modelRouter/open/conversations/{id}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Conversation ID ', 'description' => 'The conversation ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'title' => 'Request body parameters. ', 'properties' => [ 'title' => ['title' => 'Conversation title ', 'description' => 'The new conversation title.', 'type' => 'string', 'example' => '我的对话', 'required' => false], 'chatData' => ['title' => 'Chat data in JSON format, containing message records from each model ', 'description' => 'A JSON string that contains the message history for each model in the conversation.', 'type' => 'string', 'example' => '{"messages":[{"role":"user","content":"你好"}]}', 'required' => false], 'messageCount' => ['title' => 'Message quantity ', 'description' => 'The number of messages in the conversation.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'required' => false], 'modelIds' => ['title' => 'List of model IDs, as a JSON array string ', 'description' => 'A JSON-formatted string that represents an array of model IDs.', 'type' => 'string', 'example' => '[1,2,3]', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The unique request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message code ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'A detailed message that explains the error.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code of the response.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The returned data object.', 'example' => '[]', '$ref' => '#/components/schemas/ConversationDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "title": "更新后对话"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Update session information ', 'summary' => 'Conversation management / Update conversation', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"title\\": \\"我的对话\\",\\n \\"messageCount\\": 10,\\n \\"modelIds\\": \\"[1,2,3]\\",\\n \\"chatData\\": \\"{}\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\"\\n }\\n}","type":"json"}]', ], 'ModelRouterUpdateModel' => [ 'summary' => 'Model Management / Update Model', 'path' => '/api/v1/modelRouter/open/models/{id}', 'methods' => ['put'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'consumes' => ['application/json'], 'produces' => ['application/json'], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeNodes' => ['FEATUREaioralV0UKKO'], ], 'parameters' => [ [ 'name' => 'id', 'in' => 'path', 'schema' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'required' => false], ], [ 'name' => 'body', 'in' => 'body', 'style' => 'json', 'schema' => [ 'description' => 'The request body.', 'type' => 'object', 'title' => 'Request body parameters. ', 'properties' => [ 'name' => ['title' => 'Model name', 'description' => 'The model name.', 'type' => 'string', 'example' => '通义千问', 'required' => false], 'description' => ['title' => 'Model description', 'description' => 'The model description.', 'type' => 'string', 'example' => '通义千问大模型', 'required' => false], 'status' => ['title' => 'Status', 'description' => 'The model status.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'required' => false], 'symbol' => ['title' => 'Vendor symbol ', 'description' => 'The provider symbol.', 'type' => 'string', 'example' => 'alibaba', 'required' => false], 'tags' => ['title' => 'Labels, comma-separated', 'description' => 'Comma-separated tags.', 'type' => 'string', 'example' => 'chat,NLP', 'required' => false], 'modelId' => ['title' => 'Model identity', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'qwen-turbo', 'required' => false], 'modelType' => ['title' => 'Model type', 'description' => 'The model type.', 'type' => 'string', 'example' => 'Chat', 'required' => false], 'apiKey' => ['title' => 'API key', 'description' => 'The API key.', 'type' => 'string', 'example' => 'sk-xxxx', 'required' => false], 'baseUrl' => ['title' => 'Base URL ', 'description' => 'The base URL.', 'type' => 'string', 'example' => 'https://dashscope.aliyuncs.com', 'required' => false], 'maxInputLength' => ['title' => 'Maximum input length', 'description' => 'The maximum input length.', 'type' => 'string', 'example' => '8192', 'required' => false], 'maxOutputLength' => ['title' => 'Maximum output length', 'description' => 'The maximum output length.', 'type' => 'string', 'example' => '2048', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'description' => 'The response object.', 'title' => 'OpenApiSingleResponse ', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded ', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => ['title' => 'Data object ', 'description' => 'The data object.', 'example' => '[]', '$ref' => '#/components/schemas/ModelDTO'], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "data": {"id": 1, "name": "更新后模型"},'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 403 => [ ['errorCode' => 'B.Permission.DeniedException', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'Server.Internal.UnknownError', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'title' => 'Update model information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"id\\": 1,\\n \\"name\\": \\"通义千问\\",\\n \\"description\\": \\"通义千问大模型\\",\\n \\"symbol\\": \\"alibaba\\",\\n \\"tags\\": \\"chat,NLP\\",\\n \\"modelCode\\": \\"qwen-turbo\\",\\n \\"modelType\\": \\"Chat\\",\\n \\"apiKeyPreview\\": \\"sk-xxx****xxx\\",\\n \\"baseUrl\\": \\"https://dashscope.aliyuncs.com\\",\\n \\"maxInputLength\\": \\"8192\\",\\n \\"maxOutputLength\\": \\"2048\\",\\n \\"isCustom\\": false,\\n \\"tagNames\\": \\"对话,自然语言处理\\",\\n \\"deleteTag\\": 0,\\n \\"gmtCreate\\": \\"2024-01-01T00:00:00Z\\",\\n \\"gmtModified\\": \\"2024-01-01T00:00:00Z\\",\\n \\"version\\": 0,\\n \\"hasBillingRule\\": false,\\n \\"inOut\\": \\"\\",\\n \\"extensions\\": \\"\\"\\n }\\n}","type":"json"}]', ], 'PersonalizedTextToImageAddInferenceJob' => [ 'summary' => 'Personalized text-to-image: Create image inference tasks using a pre-trained model.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'imageUrl' => [ 'title' => '', 'description' => 'An array containing one or more image URLs. For example, `["url_1", "url_2", ...]`.', 'type' => 'array', 'items' => ['description' => 'The image URL. Ensure the URL is publicly accessible; otherwise, the image cannot be displayed.', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg', 'title' => ''], 'required' => true, 'example' => '', ], 'trainSteps' => ['description' => 'The number of training steps for the model.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '800'], 'prompt' => ['description' => 'The English prompt for image generation. Use the placeholder for the subject. For example, change "a man in the snow" to "a in the snow".', 'type' => 'string', 'required' => true, 'example' => 'a in the snow', 'title' => ''], 'imageNumber' => ['description' => 'The number of images to generate. Note: The maximum is 10 images per request in the test environment. If the value exceeds 10, it is treated as 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], 'seed' => ['description' => 'A random seed to ensure reproducible image generation. The value must be within `[-1, 2147483647]`. If the value is outside this range or omitted, the system automatically generates a seed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], 'strength' => ['description' => 'Determines the influence of the reference image.'."\n" .'Valid values: `0.3`, `0.4`, `0.5`, `0.6`, `0.7`, and `0.8`.'."\n" .'A lower value decreases the influence of the reference image and increases the influence of the text prompt.'."\n" .'The default is `0.5`, and you typically do not need to change this value.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => '', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code returned when success is false.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message returned when success is false.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The object containing the details of the model inference job.', 'type' => 'object', 'properties' => [ 'id' => ['description' => 'The ID of the model inference job.', 'type' => 'string', 'example' => '3220', 'title' => ''], 'promptId' => ['title' => 'promptId', 'description' => 'The prompt ID.', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'], 'modelId' => ['description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx', 'title' => ''], 'jobStatus' => [ 'description' => 'The status of the model inference job.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], 'title' => '', ], 'jobTrainProgress' => ['description' => 'The training progress of the model inference job.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], 'resultImageUrl' => [ 'title' => '', 'description' => 'A list of URLs for the images generated by the job.', 'type' => 'array', 'items' => ['description' => 'The URL of a single image generated by the job.', 'type' => 'string', 'example' => '0000.png', 'title' => ''], 'example' => '0000.png', ], 'createTime' => ['description' => 'The creation time of the model inference job.', 'type' => 'string', 'example' => '2023-12-25T12:00:00', 'title' => ''], ], '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' => 'Add a preset model inference job ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:PersonalizedTextToImageAddPreModelInferenceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'PersonalizedTextToImageQueryImageAsset' => [ 'summary' => 'Retrieves the content of an image from the personalized text-to-image service using its unique image ID.', 'path' => '/api/v1/personalizedtxt2img/queryImageAssetFromImageId', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'imageId', 'in' => 'query', 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => '0000.png', 'title' => ''], ], [ 'name' => 'encodeFormat', 'in' => 'query', 'schema' => [ 'description' => 'The image encoding format. For example, specify `base64` to receive the image data as a Base64-encoded string.', 'type' => 'string', 'example' => 'base64', 'enum' => ['base64'], 'title' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => ['title' => 'Object', 'description' => 'The image\'s binary data.', 'type' => 'any', 'example' => 'BinaryData'], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''], ], 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], [ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]', 'title' => 'Retrieve image resource ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:PersonalizedTextToImageQueryImageAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'PersonalizedTextToImageQueryPreModelInferenceJobInfo' => [ 'summary' => 'Queries the status of a personalized text-to-image inference job.', 'path' => '/api/v1/personalizedtxt2img/queryPreModelInferenceJobInfo', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'inferenceJobId', 'in' => 'query', 'schema' => ['description' => 'The inference job ID.', 'type' => 'string', 'required' => true, 'example' => 'girl-xxxx-xxxx-xxxx-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The response data object.', 'type' => 'object', 'properties' => [ 'id' => ['description' => 'The inference job ID.', 'type' => 'string', 'example' => '3220', 'title' => ''], 'promptId' => ['title' => 'promptId', 'description' => 'The ID of the prompt used for the job.', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'], 'modelId' => ['description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx', 'title' => ''], 'jobStatus' => [ 'description' => 'The job status.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], 'title' => '', ], 'jobTrainProgress' => ['description' => 'The job progress.', 'type' => 'number', 'format' => 'double', 'example' => '0.5', 'title' => ''], 'resultImageUrl' => [ 'title' => '', 'description' => 'A list of resource IDs for the generated images.', 'type' => 'array', 'items' => ['description' => 'The resource ID of a generated image.', 'type' => 'string', 'example' => '0000.png', 'title' => ''], 'example' => '0000.png', ], 'createTime' => ['description' => 'The creation time of the inference job.', 'type' => 'string', 'example' => '2023-12-25T12:00:00', 'title' => ''], ], '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' => '必要参数没有找到', 'description' => ''], ], 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], [ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\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' => 'Query preset model inference job information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:PersonalizedTextToImageQueryPreModelInferenceJobInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Personalizedtxt2imgAddInferenceJob' => [ 'summary' => 'Creates an inference job to generate images based on a personalized text-to-image model.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'modelId' => ['description' => 'The model ID to use for the inference job.', 'type' => 'string', 'required' => true, 'example' => 'xxxx-xxxx-xxxx', 'title' => ''], 'prompt' => ['description' => 'An English prompt describing the image to generate. Replace the subject with . For example, change "a man in the snow" to "a in the snow", and "a photo of a girl" to "a photo of a ".', 'type' => 'string', 'required' => true, 'example' => 'a in the snow', 'title' => ''], 'imageNumber' => ['description' => 'The number of images to generate. Note: Due to resource limits in the test environment, you can generate up to 10 images per request. The system automatically sets values greater than 10 to 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], 'seed' => ['description' => 'The seed for the random number generator. Using the same seed ensures reproducible results. The value must be between -1 and 2,147,483,647. If the value is outside this range or is not specified, the system automatically generates a suitable seed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => '', 'required' => false], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'The response object.', 'type' => 'object', '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", '$ref' => '#/components/schemas/OpenApiSingleResponse', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the request succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error code', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The data object.', 'title' => 'Data object', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Model inference job ID', 'description' => 'The model inference job ID.', 'type' => 'string', 'example' => '3220'], 'promptId' => ['title' => 'Prompt ID', 'description' => 'The prompt ID.', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'], 'modelId' => ['title' => 'Model ID', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'], 'jobStatus' => [ 'title' => 'Model inference job status', 'description' => 'The job status.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], ], 'jobTrainProgress' => ['title' => 'Progress of the model inference job', 'description' => 'The inference job progress.', 'type' => 'number', 'format' => 'double', 'example' => '0.5'], 'resultImageUrl' => [ 'description' => 'A list of URLs for the generated images.', 'title' => 'List of model inference job results', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'example' => '0000.png', ], 'createTime' => ['title' => 'Creation time of the model inference job', 'description' => 'The inference job\'s creation time.', 'type' => 'string', 'example' => '2023-12-25T12:00:00'], ], '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 \\"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' => 'Personalized text-to-image / Create an image inference job based on a model', 'changeSet' => [ ['createdAt' => '2025-03-05T08:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgAddInferenceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Personalizedtxt2imgAddModelTrainJob' => [ 'summary' => 'Personalized text-to-image: Create a model training task.', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'name' => ['description' => 'The name of the model training job.', 'type' => 'string', 'required' => true, 'example' => '熊猫图片生成', 'title' => ''], 'objectType' => ['description' => 'A single word that defines the object type in the training images, such as "girl", "person", "man", "boy", or "dog".', 'type' => 'string', 'required' => true, 'example' => 'dog', 'title' => ''], 'imageUrl' => [ 'title' => '', 'description' => 'A list of one or more image URLs for training. For example: \\["url\\_1", "url\\_2", ...]', 'type' => 'array', 'items' => ['description' => 'A publicly accessible URL for a training image.', 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg', 'title' => ''], 'required' => true, 'example' => '', ], 'trainSteps' => ['description' => 'The number of training steps for the model training job.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '800'], ], 'required' => false, 'title' => '', 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'The response object.', 'type' => 'object', '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", '$ref' => '#/components/schemas/OpenApiSingleResponse', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'is Succeeded ', 'description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The response data.', 'title' => 'Data object', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Model training job ID', 'description' => 'The model training job ID.', 'type' => 'string', 'example' => '456'], 'modelId' => ['title' => 'Model ID', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'], 'name' => ['title' => 'Model training job name', 'description' => 'The model training job name.', 'type' => 'string', 'example' => '可爱熊猫模型训练任务'], 'objectType' => ['title' => 'Entity of the model training job ', 'description' => 'The training subject.', 'type' => 'string', 'example' => 'panda'], 'imageUrl' => [ 'description' => 'A list of image URLs for model training.', 'title' => 'List of image URLs for the model training job', 'type' => 'array', 'items' => ['description' => 'An image URL for model training.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'."\n", 'title' => ''], 'example' => '', ], 'jobStatus' => [ 'title' => 'Model training job status', 'description' => 'The status of the model training job.', 'type' => 'string', 'example' => 'TRAINING', 'enum' => ['FINISHED', 'TRAINING', 'TRAINING_TERMINATED', 'WRONG_IMAGE_URL', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], ], 'jobTrainProgress' => ['title' => 'Model training job progress ', 'description' => 'The progress of the model training job.', 'type' => 'number', 'format' => 'double', 'example' => '0.5'], 'inferenceJobList' => [ 'description' => 'A list of inference jobs.', 'title' => 'List of model inference jobs', 'type' => 'array', 'items' => [ 'description' => 'Details of a single inference job.', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Model inference job ID ', 'description' => 'The inference job ID.', 'type' => 'string', 'example' => '3220'], 'promptId' => ['title' => 'promptId ', 'description' => 'The prompt ID.', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'], 'modelId' => ['title' => 'Model ID', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'], 'jobStatus' => [ 'title' => 'Model inference job status', 'description' => 'The status of the inference job.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], ], 'jobTrainProgress' => ['title' => 'Model inference job progress ', 'description' => 'The progress of the inference job.', 'type' => 'number', 'format' => 'double', 'example' => '0.5'], 'resultImageUrl' => [ 'description' => 'A list of URLs for the resulting images.', 'title' => 'List of model inference job results', 'type' => 'array', 'items' => ['description' => 'A URL for a resulting image.', 'type' => 'string', 'example' => '0000.png', 'title' => ''], 'example' => '0000.png', ], 'createTime' => ['title' => 'Creation time of the model inference job', 'description' => 'The creation time of the inference job.', 'type' => 'string', 'example' => '2023-12-25T12:00:00'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'inferenceImageCount' => ['title' => 'Total number of images processed by model inference ', 'description' => 'The total number of images generated by this model.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'createTime' => ['title' => 'Model training job creation time', 'description' => 'The creation time of the model training job.', 'type' => 'string', 'example' => '2023-12-25T12:00:00'], ], '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 \\"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' => 'Personalized text-to-image / Create a model training Job ', 'changeSet' => [ ['createdAt' => '2025-03-05T08:54:22.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-10-12T09:35:03.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgAddModelTrainJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Personalizedtxt2imgQueryImageAsset' => [ 'summary' => 'Retrieves the binary data of an image generated by the personalized text-to-image service.', 'path' => '/api/v1/personalizedtxt2img/queryImageAsset', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['description' => 'The ID of the model.', 'type' => 'string', 'required' => true, 'example' => 'girl-xxxx-xxxx-xxxx-xxxx', 'title' => ''], ], [ 'name' => 'promptId', 'in' => 'query', 'schema' => ['description' => 'The ID of the prompt.', 'type' => 'string', 'required' => true, 'example' => 'xxxx-xxxx-xxxx-xxxx', 'title' => ''], ], [ 'name' => 'imageId', 'in' => 'query', 'schema' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => true, 'example' => '0000.png', 'title' => ''], ], [ 'name' => 'encodeFormat', 'in' => 'query', 'schema' => [ 'description' => 'The encoding format of the image. If this parameter is set to `base64`, the image is returned as a Base64-encoded string. If this parameter is omitted, the raw binary data of the image is returned.', 'type' => 'string', 'example' => 'base64', 'enum' => ['base64'], 'title' => '', 'required' => false, ], ], ], 'responses' => [ 200 => [ 'schema' => ['title' => 'Object', 'description' => 'The binary data of the image.', 'type' => 'any', 'example' => 'BinaryData'], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''], ], 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], [ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"\\"BinaryData\\"","type":"json"}]', 'title' => 'Retrieve personalized text-to-image or image binary content.', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryImageAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Personalizedtxt2imgQueryInferenceJobInfo' => [ 'summary' => 'Retrieves the status and results of a Personalizedtxt2img inference job.', 'path' => '/api/v1/personalizedtxt2img/queryInferenceJobInfo', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'inferenceJobId', 'in' => 'query', 'schema' => ['description' => 'The ID of the inference job.', 'type' => 'string', 'required' => true, 'example' => '180', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'The response object.', 'type' => 'object', '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"}}', '$ref' => '#/components/schemas/OpenApiSingleResponse', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Indicates whether the operation succeeded', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The object that contains the query results.', 'title' => 'Data object ', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Model inference job ID ', 'description' => 'The ID of the inference job.', 'type' => 'string', 'example' => '3220'], 'promptId' => ['title' => 'Prompt ID ', 'description' => 'The ID of the prompt.', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'], 'modelId' => ['title' => 'Model ID ', 'description' => 'The ID of the model.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'], 'jobStatus' => [ 'title' => 'Model inference job status ', 'description' => 'The status of the inference job.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], ], 'jobTrainProgress' => ['title' => 'Model inference job progress', 'description' => 'The progress of the inference job.', 'type' => 'number', 'format' => 'double', 'example' => '0.5'], 'resultImageUrl' => [ 'description' => 'A list of URLs for the generated images.', 'title' => 'List of model inference job results ', 'type' => 'array', 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], 'example' => '0000.png', ], 'createTime' => ['title' => 'Model inference job creation time ', 'description' => 'The time when the inference job was created.', 'type' => 'string', 'example' => '2023-12-25T12:00:00'], ], 'example' => '[]', ], ], ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''], ], 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], [ ['errorCode' => 'B_DATA_NOT_FOUND_EXCEPTION', 'errorMessage' => '资源没有找到', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\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' => 'Personalized text-to-image / Query the status and result information of a model inference job', 'changeSet' => [ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => 'Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryInferenceJobInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Personalizedtxt2imgQueryModelTrainJobList' => [ 'summary' => 'Your personalized model training tasks: image generation and query models.', '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', 'description' => 'The response body.', '$ref' => '#/components/schemas/OpenApiMultiResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID ', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Success status ', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message encoding ', 'description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message ', 'description' => 'The error message.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code ', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The list of model training jobs.', 'title' => 'Data object ', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Model training job ID ', 'description' => 'The model training job ID.', 'type' => 'string', 'example' => '456'], 'modelId' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'], 'name' => ['title' => 'Model training job name ', 'description' => 'The model training job name.', 'type' => 'string', 'example' => '可爱熊猫模型训练任务'], 'objectType' => ['title' => 'Training entity of the model training job', 'description' => 'The object type.', 'type' => 'string', 'example' => 'panda'], 'imageUrl' => [ 'description' => 'A list of image URLs for model training.', 'title' => 'List of image URLs for the model training job ', 'type' => 'array', 'items' => ['description' => 'An image URL for model training.', 'type' => 'string', 'example' => 'https://img.alicdn.com/imgextra/i2/O1CN011Ps6OK1LdWZQSUZD1_!!6000000001322-0-tps-572-1096.jpg'."\n", 'title' => ''], 'example' => '', ], 'jobStatus' => [ 'title' => 'Model training job status ', 'description' => 'The status of the model training job.', 'type' => 'string', 'example' => 'TRAINING', 'enum' => ['FINISHED', 'TRAINING', 'TRAINING_TERMINATED', 'WRONG_IMAGE_URL', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], ], 'jobTrainProgress' => ['title' => 'Model training job progress', 'description' => 'The progress of the model training job.', 'type' => 'number', 'format' => 'double', 'example' => '0.5'], 'inferenceJobList' => [ 'description' => 'A list of model inference jobs.', 'title' => 'List of model inference jobs ', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ 'id' => ['title' => 'Model inference job ID', 'description' => 'The model inference job ID.', 'type' => 'string', 'example' => '3220'], 'promptId' => ['title' => 'promptId', 'description' => 'The prompt ID.', 'type' => 'string', 'example' => 'promptId-xxxx-xxxx-xxxx'], 'modelId' => ['title' => 'Model ID ', 'description' => 'The model ID.', 'type' => 'string', 'example' => 'modelId-xxxx-xxxx-xxxx'], 'jobStatus' => [ 'title' => 'Model inference job status ', 'description' => 'The status of the model inference job.', 'type' => 'string', 'example' => 'FINISHED', 'enum' => ['FINISHED', 'INFERRING', 'INFERRING_TERMINATED', 'OOM', 'FINISHED', 'SUBMITTED', 'WAIT_SCHEDULE', 'TOO_MANY_INFERENCE_REQUESTS'], ], 'jobTrainProgress' => ['title' => 'Model inference job progress', 'description' => 'The progress of the model inference job.', 'type' => 'number', 'format' => 'double', 'example' => '0.5'], 'resultImageUrl' => [ 'description' => 'A list of result image URLs from the inference job.', 'title' => 'List of model inference job results ', 'type' => 'array', 'items' => ['description' => 'A result image URL from the inference job.', 'type' => 'string', 'example' => '0000.png', 'title' => ''], 'example' => '0000.png', ], 'createTime' => ['title' => 'Creation time of the model inference job', 'description' => 'The creation time of the model inference job.', 'type' => 'string', 'example' => '2023-12-25T12:00:00'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'inferenceImageCount' => ['title' => 'Total number of images inferred by this model', 'description' => 'The number of inference images generated by the model.', 'type' => 'integer', 'format' => 'int32', 'example' => '5'], 'createTime' => ['title' => 'Model training job creation time ', 'description' => 'The creation time of the model training job.', 'type' => 'string', 'example' => '2023-12-25T12:00:00'], ], 'title' => '', 'example' => '', ], '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' => 'Personalized text-to-image / Query model training Job List', 'changeSet' => [ ['createdAt' => '2025-03-05T08:54:21.000Z', 'description' => 'Error codes changed'], ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'Personalizedtxt2imgQueryModelTrainStatus' => [ 'summary' => 'Queries the training status of a personalized text-to-image model.', 'path' => '/api/v1/personalizedtxt2img/queryModelTrainStatus', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'modelId', 'in' => 'query', 'schema' => ['description' => 'The model ID.', 'type' => 'string', 'required' => true, 'example' => 'modelId-xxxx-xxxx-xxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiSingleResponse', 'description' => 'The response object.', '$ref' => '#/components/schemas/OpenApiSingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['title' => 'Request ID', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx'], 'success' => ['title' => 'Success status', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], 'errCode' => ['title' => 'Error message code', 'description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR'], 'errMessage' => ['title' => 'Error message', 'description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => '未知错误'], 'httpStatusCode' => ['title' => 'HTTP status code', 'description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], 'data' => [ 'description' => 'The returned data object.', 'title' => 'Data object', 'type' => 'object', 'properties' => [ 'modelTrainStatus' => ['title' => 'Model training status', 'description' => 'The model training status.', 'type' => 'string', 'example' => 'FINISHED'], ], 'example' => '[]', ], ], 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ ['errorCode' => 'B_PARAMETER_NOT_FOUND_EXCEPTION', 'errorMessage' => '必要参数没有找到', 'description' => ''], ], 403 => [ ['errorCode' => 'B_PERMISSION_DENIED_EXCEPTION', 'errorMessage' => '鉴权失败或权限不足', 'description' => ''], ], [ ['errorCode' => 'B_MODEL_TRAIN_JOB_NOT_EXIST', 'errorMessage' => '模型训练任务不存在', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"modelTrainStatus\\": \\"FINISHED\\"\\n }\\n}","type":"json"}]', 'title' => 'Query the status of personalized text-to-image/model training', 'changeSet' => [ ['createdAt' => '2024-07-31T04:03:07.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryApplicationAccessId' => [ 'summary' => 'Queries information about an application access ID (appkey).', 'path' => '/api/v1/aliyunConsole/queryApplicationAccessId', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'applicationAccessId', 'in' => 'query', 'schema' => ['description' => 'The application access ID (appkey).', 'type' => 'string', 'example' => '1234567890', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SingleResponse', 'description' => 'SingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['description' => 'The application access ID (appkey).', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'applicationAccessSecret' => ['description' => 'The application access secret. This parameter is returned only for requests from the Alibaba Cloud console.', 'type' => 'string', 'example' => 'MyAppSecret', 'title' => ''], ], 'example' => '[]', ], ], 'example' => '{'."\n" .' "success": true,'."\n" .' "requestId": "592A27EF-26D3-1434-98C1-97AD63337852"'."\n" .'}', ], ], ], 'errorCodes' => [ 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"applicationAccessId\\": \\"1234567890\\",\\n \\"applicationAccessSecret\\": \\"MyAppSecret\\"\\n }\\n}","type":"json"}]', 'title' => 'Query application access ID', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:QueryApplicationAccessId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryProject' => [ 'summary' => 'Alibaba Cloud console / Project list', 'path' => '/api/v1/aliyunConsole/queryProject', 'methods' => ['get'], 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'projectId', 'in' => 'query', 'schema' => ['description' => 'The ID of the project.', 'type' => 'string', 'example' => '123', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SingleResponse', 'description' => 'The response object.', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates if the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The returned data, which contains the details of the project.', 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '67055'], 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'MyProject', 'title' => ''], 'ProjectType' => ['description' => 'The project type.', 'type' => 'string', 'example' => 'WebApplication', 'title' => ''], 'ProjectApps' => [ 'title' => '', 'description' => 'The list of applications in the project.', 'type' => 'array', 'items' => [ 'description' => 'An application within the project.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => '2144'], 'ApplicationAccessIds' => [ 'title' => '', 'description' => 'The application access credentials.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['description' => 'The application ID, also known as the AppKey.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'applicationAccessSecret' => ['description' => 'The application secret. This parameter is returned only for requests from the console.', 'type' => 'string', 'example' => 'MyAppSecret', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '159'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectSDK' => [ 'title' => '', 'description' => 'The list of SDKs associated with the project.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SdkName' => ['description' => 'The SDK name.', 'type' => 'string', 'title' => '', 'example' => 'JSSDK'], 'DeployMode' => ['description' => 'The deployment mode. Valid values: `client` or `server`.', 'type' => 'string', 'title' => '', 'example' => '服务端'], 'DevelopLanguage' => ['description' => 'The development language. For example: JAVA.', 'type' => 'string', 'title' => '', 'example' => 'JAVA'], 'SdkUrl' => ['description' => 'The SDK URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/sdk.zip'], 'DocUrl' => ['description' => 'The document URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/doc'], 'DemoUrl' => ['description' => 'The demo URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/demo'], 'SdkVersion' => ['description' => 'The SDK version.', 'type' => 'string', 'title' => '', 'example' => '5.1.0'], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-11-01T13:40:53Z'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', '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' => '鉴权失败或权限不足', 'description' => ''], ], 500 => [ ['errorCode' => 'UNKNOWN_ERROR', 'errorMessage' => 'The request processing has failed due to some unknown error.', 'description' => ''], ], ], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"requestId\\": \\"xxxx-xxxx-xxxx-xxxxxxxx\\",\\n \\"success\\": true,\\n \\"errCode\\": \\"UNKNOWN_ERROR\\",\\n \\"errMessage\\": \\"未知错误\\",\\n \\"httpStatusCode\\": 200,\\n \\"data\\": {\\n \\"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' => 'Query project information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:QueryProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryProjectList' => [ 'summary' => 'Alibaba Cloud console / Project List', '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', 'description' => 'OpenApiMultiResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'A list of projects.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '4910'], 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'MyProject', 'title' => ''], 'ProjectType' => ['description' => 'The project type.', 'type' => 'string', 'example' => 'WebApplication', 'title' => ''], 'ProjectApps' => [ 'title' => '', 'description' => 'A list of applications in the project.', 'type' => 'array', 'items' => [ 'description' => 'An application object.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The application ID.', 'type' => 'string', 'title' => '', 'example' => '4700'], 'ApplicationAccessIds' => [ 'title' => '', 'description' => 'A list of access credentials for the application.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['description' => 'The application access ID, also known as the appkey.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'applicationAccessSecret' => ['description' => 'The application access secret. This field is returned only for requests made from the console.', 'type' => 'string', 'example' => 'MyAppSecret', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '4747'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectSDK' => [ 'title' => '', 'description' => 'A list of SDKs for the project.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SdkName' => ['description' => 'The SDK name.', 'type' => 'string', 'title' => '', 'example' => 'GO AUTH'], 'DeployMode' => ['description' => 'The deployment mode. Valid values: client-side and server-side.', 'type' => 'string', 'title' => '', 'example' => '服务端'], 'DevelopLanguage' => ['description' => 'The development language.', 'type' => 'string', 'title' => '', 'example' => 'JAVA'], 'SdkUrl' => ['description' => 'The SDK URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/sdk.zip'], 'DocUrl' => ['description' => 'The documentation URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/doc'], 'DemoUrl' => ['description' => 'The demo URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/demo'], 'SdkVersion' => ['description' => 'The SDK version.', 'type' => 'string', 'title' => '', 'example' => '.3.52'], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-07-16T08:23:19Z'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2025-02-18 12:10:22'], ], 'description' => '', 'title' => '', 'example' => '', ], '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' => 'Query project List', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:QueryProjectList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'QueryPurchasedService' => [ 'summary' => 'Alibaba Cloud Console / Purchased Services', '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', 'description' => 'OpenApiMultiResponse\\', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'array', 'items' => ['description' => 'The service information structure.', '$ref' => '#/components/schemas/AliyunConsoleServiceInfoDTO', 'title' => '', 'example' => ''], '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' => 'Query purchased services', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:QueryPurchasedService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], 'UpdateProject' => [ 'summary' => 'Alibaba Cloud Console / Update project information', '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' => 'The request body.', 'type' => 'object', 'properties' => [ 'projectId' => ['description' => 'The ID of the project.', 'type' => 'string', 'example' => '123', 'title' => '', 'required' => false], 'projectName' => ['description' => 'The new name of the project.', 'type' => 'string', 'example' => 'MyProject', 'title' => '', 'required' => false], ], 'required' => false, 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'SingleResponse', 'description' => 'SingleResponse', 'type' => 'object', 'properties' => [ 'requestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'xxxx-xxxx-xxxx-xxxxxxxx', 'title' => ''], 'success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'errCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'UNKNOWN_ERROR', 'title' => ''], 'errMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => '未知错误', 'title' => ''], 'httpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'data' => [ 'title' => '', 'description' => 'The data object.', 'type' => 'object', 'properties' => [ 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '56160'], 'ProjectName' => ['description' => 'The project name.', 'type' => 'string', 'example' => 'MyProject', 'title' => ''], 'ProjectType' => ['description' => 'The project type.', 'type' => 'string', 'example' => 'WebApplication', 'title' => ''], 'ProjectApps' => [ 'title' => '', 'description' => 'The list of project applications.', 'type' => 'array', 'items' => [ 'description' => 'The application structure.', 'type' => 'object', 'properties' => [ 'Id' => ['description' => 'The internal ID of the application.', 'type' => 'string', 'title' => '', 'example' => '4498'], 'ApplicationAccessIds' => [ 'title' => '', 'description' => 'The application access credentials.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'applicationAccessId' => ['description' => 'The application identifier, also known as the AppKey.', 'type' => 'string', 'example' => '1234567890', 'title' => ''], 'applicationAccessSecret' => ['description' => 'The application secret. This is returned only for requests from the console.', 'type' => 'string', 'example' => 'MyAppSecret', 'title' => ''], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectId' => ['description' => 'The project ID.', 'type' => 'string', 'title' => '', 'example' => '1889'], ], 'title' => '', 'example' => '', ], 'example' => '', ], 'ProjectSDK' => [ 'title' => '', 'description' => 'The project SDK.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'SdkName' => ['description' => 'The SDK name.', 'type' => 'string', 'title' => '', 'example' => 'PHP服务端SDK'], 'DeployMode' => ['description' => 'The deployment mode. Valid values: client-side or server-side.', 'type' => 'string', 'title' => '', 'example' => '服务端'], 'DevelopLanguage' => ['description' => 'The development language.', 'type' => 'string', 'title' => '', 'example' => 'PHP'], 'SdkUrl' => ['description' => 'The SDK URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/sdk.zip'], 'DocUrl' => ['description' => 'The documentation URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/doc'], 'DemoUrl' => ['description' => 'The demo URL.', 'type' => 'string', 'title' => '', 'example' => 'http://demo.com/demo'], 'SdkVersion' => ['description' => 'The SDK version.', 'type' => 'string', 'title' => '', 'example' => '4.13.0'], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', 'example' => '2024-11-01T13:40:53Z'], ], 'description' => '', 'title' => '', 'example' => '', ], 'example' => '', ], 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'title' => '', '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' => 'Update Project Information ', 'changeSet' => [], 'flowControl' => [ 'flowControlList' => [], ], 'ramActions' => [ [ 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:UpdateProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], ], ], 'endpoints' => [ ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aicontent.cn-beijing.aliyuncs.com', 'endpoint' => 'aicontent.cn-beijing.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aicontent.cn-hangzhou.aliyuncs.com', 'endpoint' => 'aicontent.cn-hangzhou.aliyuncs.com', 'vpc' => ''], ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'aicontent.aliyuncs.com', 'endpoint' => 'aicontent.aliyuncs.com', 'vpc' => 'aicontent-vpc.cn-shanghai.aliyuncs.com'], ['regionId' => 'public', 'regionName' => 'Public network', 'areaId' => 'other', 'areaName' => 'Other', 'public' => 'aicontent.aliyuncs.com', 'endpoint' => 'aicontent.aliyuncs.com', 'vpc' => ''], ], 'errorCodes' => [ ['code' => 'B.Permission.OrgNoExistException', 'message' => 'B.Permission .OrgNoExistException.', 'http_code' => 403, 'description' => 'Authentication failed-Organization does not exist'], ], 'changeSet' => [ [ 'apis' => [ ['description' => 'Request parameters changed', 'api' => 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun'], ['description' => 'Request parameters changed', 'api' => 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun'], ['description' => 'Request parameters changed', 'api' => 'ExecuteAITeacherEnglishParaphraseChatMessage'], ], 'createdAt' => '2025-04-23T03:18:49.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'Personalizedtxt2imgAddInferenceJob'], ['description' => 'Error codes changed', 'api' => 'Personalizedtxt2imgAddModelTrainJob'], ['description' => 'Error codes changed', 'api' => 'Personalizedtxt2imgQueryModelTrainJobList'], ], 'createdAt' => '2025-03-05T08:54:28.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Response parameters changed', 'api' => 'GetAITeacherSyncDialogueSuggestion'], ], 'createdAt' => '2024-12-30T02:53:41.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed', 'api' => 'Personalizedtxt2imgAddModelTrainJob'], ], 'createdAt' => '2024-10-12T09:35:10.000Z', 'description' => '', ], [ 'apis' => [ ['description' => 'Error codes changed, Response parameters changed', 'api' => 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList'], ['description' => 'Response parameters changed', 'api' => 'Personalizedtxt2imgAddInferenceJob'], ['description' => 'Response parameters changed, Error codes changed', 'api' => 'Personalizedtxt2imgAddModelTrainJob'], ['description' => 'Response parameters changed', 'api' => 'Personalizedtxt2imgQueryInferenceJobInfo'], ['description' => 'Error codes changed, Response parameters changed', 'api' => 'Personalizedtxt2imgQueryModelTrainJobList'], ['description' => 'Error codes changed, Response parameters changed', 'api' => 'Personalizedtxt2imgQueryModelTrainStatus'], ], 'createdAt' => '2024-07-31T04:03:12.000Z', 'description' => '', ], ], 'flowControl' => [ 'flowControlList' => [], ], 'ram' => [ 'productCode' => 'AiContent', 'productName' => 'Smart Science and Education Content Platform', 'ramCodes' => ['aicontent'], 'ramLevel' => 'OPERATION', 'ramConditions' => [], 'ramActions' => [ [ 'apiName' => 'ModelRouterQueryUsageBreakdown', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryUsageBreakdown', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantStartConversation', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantStartConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PersonalizedTextToImageQueryPreModelInferenceJobInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:PersonalizedTextToImageQueryPreModelInferenceJobInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCreateApiKey', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryCostOverviewMetrics', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostOverviewMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AliyunConsoleOpenApiQueryAliyunConsoleServiceList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServiceList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AITeacherExpansionPracticeTaskGenerate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExpansionPracticeTaskGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryProject', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:QueryProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryBillingRuleList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryBillingRuleList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Personalizedtxt2imgAddInferenceJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgAddInferenceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherExpansionDialogue', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:AITeacherExecuteExpansionPractice', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateAccessWarrant', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:CreateAccessWarrant', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryClientDiscountLogs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryClientDiscountLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterUpdateClient', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherEnglishCompositionTutoringWorkflowRun', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherEnglishCompositionTutoringWorkflowRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterGetClientBalance', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterGetClientBalance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterUpdateConversation', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTextbookAssistantBookDirectories', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantBookDirectories', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherExpansionDialogueRefine', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueRefine', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCreateBalanceTransaction', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateBalanceTransaction', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantDialogue', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterUpdateBillingRule', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateBillingRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterConfigureClientBalance', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterConfigureClientBalance', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterChatCompletions', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterChatCompletions', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CreateProject', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:CreateProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryApiKeyList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryApiKeyList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterBillingCostTabs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterBillingCostTabs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Personalizedtxt2imgQueryModelTrainJobList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainJobList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CountOralEvaluationStatisticsCalls', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:countOralEvaluationStatisticsCalls', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherGrammarCheck', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherGrammarCheck', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherSyncDialogueTranslate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherSyncDialogueTranslate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AITeacherSyncPracticeTaskGenerate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:SyncPracticeTasksGenerate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryClientTree', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryClientTree', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterDeleteApiKey', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherSyncDialogue', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherSyncDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Personalizedtxt2imgQueryInferenceJobInfo', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryInferenceJobInfo', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantSuggestion', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantSuggestion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterDeleteClient', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherChineseCompositionTutoringWorkflowRun', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherChineseCompositionTutoringWorkflowRun', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterGetClientBalanceLogs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterGetClientBalanceLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PersonalizedTextToImageQueryImageAsset', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:PersonalizedTextToImageQueryImageAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryApiKey', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCreateClient', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateClient', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAITeacherSyncDialogueSuggestion', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:GetAITeacherSyncDialogueSuggestion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherExpansionDialogueTranslate', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherExpansionDialogueTranslate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetTextbookAssistantToken', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:GetTextbookAssistantToken', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryCostTrendMetrics', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostTrendMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryBillingCostBreakdown', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryBillingCostBreakdown', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryObservationLogs', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryObservationLogs', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'PersonalizedTextToImageAddInferenceJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:PersonalizedTextToImageAddPreModelInferenceJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'GetAITeacherExpansionDialogueSuggestion', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:GetAITeacherExpansionDialogueSuggestion', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterDeleteConversation', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTextbookAssistantGradeVolumes', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantGradeVolumes', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCopyApiKey', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCopyApiKey', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryNacosProviders', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryNacosProviders', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCreateConversation', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantDifficulty', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantDifficulty', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTextbookAssistantArticleDetails', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantSceneDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantTranslate', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantTranslate', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryPurchasedService', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:QueryPurchasedService', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Personalizedtxt2imgQueryImageAsset', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryImageAsset', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCreateBillingRule', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateBillingRule', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTextbookAssistantBooks', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantBooks', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTextbookAssistantArticles', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantArticles', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryProjectList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:QueryProjectList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterDeleteModel', 'description' => '', 'operationType' => 'delete', 'ramAction' => [ 'action' => 'aicontent:ModelRouterDeleteModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryObservationCharts', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryObservationCharts', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteAITeacherEnglishParaphraseChatMessage', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteAITeacherEnglishParaphraseChatMessage', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantGrammarCheck', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantGrammarCheck', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AliyunConsoleOpenApiQueryAliyunConsoleServcieList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:AliyunConsoleOpenApiQueryAliyunConsoleServcieList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterUpdateModel', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:ModelRouterUpdateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'QueryApplicationAccessId', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:QueryApplicationAccessId', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'UpdateProject', 'description' => '', 'operationType' => 'update', 'ramAction' => [ 'action' => 'aicontent:UpdateProject', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryClientList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryClientList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ListTextbookAssistantSceneDetails', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ListTextbookAssistantArticleDetails', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryModelList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryModelList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'AliyunConsoleOpenApiQueryPaidResource', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:AliyunConsoleOpenApiQueryPaidResource', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantRefineByContext', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantRefineByContext', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantSseDialogue', 'description' => '', 'operationType' => 'none', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantSseDialogue', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryCostModelList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostModelList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryObservationMetrics', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryObservationMetrics', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryModel', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CountOralEvaluationStatisticsError', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:countOralEvaluationStatisticsError', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryConversation', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'CountOralEvaluationStatisticsConcurrent', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:countOralEvaluationStatisticsConcurrent', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Personalizedtxt2imgAddModelTrainJob', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgAddModelTrainJob', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ExecuteTextbookAssistantRetryConversation', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ExecuteTextbookAssistantRetryConversation', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'Personalizedtxt2imgQueryModelTrainStatus', 'description' => '', 'operationType' => 'get', 'ramAction' => [ 'action' => 'aicontent:Personalizedtxt2imgQueryModelTrainStatus', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryNacosTags', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryNacosTags', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterSaveFlowConfig', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterSaveFlowConfig', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryConversationList', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryConversationList', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterCreateModel', 'description' => '', 'operationType' => 'create', 'ramAction' => [ 'action' => 'aicontent:ModelRouterCreateModel', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], [ 'apiName' => 'ModelRouterQueryCostModelDetail', 'description' => '', 'operationType' => 'list', 'ramAction' => [ 'action' => 'aicontent:ModelRouterQueryCostModelDetail', 'authLevel' => 'operate', 'actionConditions' => [], 'resources' => [ ['validationType' => 'always', 'product' => 'AiContent', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], 'resourceTypes' => [], ], ];