本产品(
智能教育内容生成/20240611)的OpenAPI采用ROA签名风格,签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(78410016550),在专家指导下进行签名对接。在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。
API目录
| API | 标题 | API概述 |
|---|---|---|
| AliyunConsoleOpenApiQueryAliyunConsoleServiceList | 服务列表查询 | 阿里云控制台/列出阿里云控制台上可使用的服务列表。 |
百科
| API | 标题 | API概述 |
|---|---|---|
| ExecuteHundredThousandWhysDialogue | 本接口下线进行中,请勿调用(与十万个为什么的AI进行对话) | 本接口下线进行中,请勿调用(原:十万个为什么对话接入)。 |
口语评测
| API | 标题 | API概述 |
|---|---|---|
| CreateAccessWarrant | 创建授权信息 | 阿里云控制台/授权凭证创建。 |
| QueryApplicationAccessId | 查询应用访问编号 | 阿里云控制台/获取应用访问识别码(appkey)信息。 |
| QueryProjectList | 查询项目列表 | 阿里云控制台/获取项目列表 |
| QueryProject | 查询项目信息 | 阿里云控制台/获取项目列表 |
| CreateProject | 创建项目 | 阿里云控制台/创建项目 |
| UpdateProject | 更新项目信息 | 阿里云控制台/更新项目信息 |
| QueryPurchasedService | 查询已购买的服务 | 阿里云控制台/已经购买过的服务项目 |
AI语文老师
| API | 标题 | API概述 |
|---|---|---|
| ExecuteAITeacherChineseCompositionTutoringWorkflowRun | 语文作文辅导 | 中文作文辅导。 |
英语教材式AI老师
| API | 标题 | API概述 |
|---|---|---|
| GetTextbookAssistantToken | 获取英语教材式AI老师功能使用授权码 | 获取请求调用授权码。 |
| ListTextbookAssistantGradeVolumes | 获取拥有英语教材资源的年级列表 | 获取拥有英语教材资源的年级列表。 |
| ListTextbookAssistantBooks | 获取英语教材的书本 | 获取包含年级下的书本列表。 |
| ListTextbookAssistantBookDirectories | 获取英语教材的书本目录 | 获取书本下的目录信息。 |
| ListTextbookAssistantArticles | 获取英语教材的文章列表 | 获取文章列表。 |
| ListTextbookAssistantArticleDetails | 获取文章详情 | 批量获取文章详情 |
| ListTextbookAssistantSceneDetails | 获取场景详情 | 获取文章内容详情 |
| ExecuteTextbookAssistantStartConversation | 开启与AI老师的对话 | 发起与AI老师的对话,由Ai老师率先发起第一句对话内容。 |
| ExecuteTextbookAssistantDialogue | 与AI老师进行对话 | 进行AI对话。 |
| ExecuteTextbookAssistantSseDialogue | AI老师进行对话-流式输出 | 进行对话-流式输出 |
| ExecuteTextbookAssistantTranslate | 获取对话消息的翻译结果 | 翻译消息内容 |
| ExecuteTextbookAssistantSuggestion | 获取对话中AI老师提问的建议回复内容 | 获取鉴权参数 |
| ExecuteTextbookAssistantDifficulty | 调整AI老师回复内容的难度 | 调整难度 |
| ExecuteTextbookAssistantRefineByContext | 获取润色用户回复消息内容的结果 | 句子润色 |
| ExecuteTextbookAssistantGrammarCheck | 获取用户回复内容的语法检测的结果 | 语法检测 |
| ExecuteTextbookAssistantRetryConversation | 重新生成AI老师的提问内容 | 对话重试 |
AI英语老师
| API | 标题 | API概述 |
|---|---|---|
| ExecuteAITeacherEnglishParaphraseChatMessage | 英语答疑 | 英语答疑 |
| ExecuteAITeacherEnglishCompositionTutoringWorkflowRun | 英语作文生成 | 英语作文辅导 |
| AITeacherSyncPracticeTaskGenerate | 同步练对话任务生成 | 同步基础练主要面向有标准答案的对话任务,虽然该模式允许用户和标准答案有一定的区别或偏差,但AI会相对严格的要求用户使用标准答案回复问题, |
| ExecuteAITeacherSyncDialogue | 执行同步练 | 进行同步练对话。 |
| ExecuteAITeacherSyncDialogueTranslate | 执行同步练翻译 | 同步练语境翻译。 |
| GetAITeacherSyncDialogueSuggestion | 获取同步练小助手提示 | 同步练小助手。 |
| AITeacherExpansionPracticeTaskGenerate | 拓展练对话任务生成 | 拓展练问答对生成。 |
| ExecuteAITeacherExpansionDialogue | 执行拓展练 | 拓展练习对话主要针对较为开放的交流场景。在练习过程中,虽然AI提出的问题没有预设答案,但用户仍需在相关话题内进行回答。若用户回答偏离主题,AI会尝试引导其回归话题。如果用户连续两次跑题,AI将引导其继续下一个话题。 |
| ExecuteAITeacherExpansionDialogueTranslate | 执行拓展练翻译 | 拓展练语境翻译。 |
| GetAITeacherExpansionDialogueSuggestion | 获取拓展练小助手提示 | 拓展练小助手。 |
| ExecuteAITeacherExpansionDialogueRefine | 执行拓展练润色 | 拓展练根据上下文进行润色。 |
| ExecuteAITeacherGrammarCheck | 执行语法检测 | 语法检测。 |
个性化文生图
| API | 标题 | API概述 |
|---|---|---|
| PersonalizedTextToImageQueryPreModelInferenceJobInfo | 查询预置模型推理任务信息 | 个性化文生图/查询预制模型推理任务的状态。 |
| PersonalizedTextToImageAddInferenceJob | 添加预置模型推理任务 | 个性化文生图/基于一个预训练模型创建图片推理任务。 |
| PersonalizedTextToImageQueryImageAsset | 图片资源获取 | 个性化文生图/通过唯一的图片编号获取图片内容。 |
| Personalizedtxt2imgQueryInferenceJobInfo | 个性化文生图/查询模型推理任务的状态和结果信息 | 个性化文生图/查询模型推理任务的状态和结果信息。 |
| Personalizedtxt2imgAddInferenceJob | 个性化文生图/基于一个模型创建图片推理任务 | 个性化文生图/基于一个模型创建图片推理任务。 |
| Personalizedtxt2imgAddModelTrainJob | 个性化文生图/创建一个模型训练任务 | 个性化文生图/创建一个模型训练任务。 |
| Personalizedtxt2imgQueryImageAsset | 个性化文生图/图片二进制内容获取 | 个性化文生图/图片二进制内容获取。 |
| Personalizedtxt2imgQueryModelTrainJobList | 个性化文生图/查询模型训练任务列表 | 个性化文生图/查询模型训练任务列表。 |
| Personalizedtxt2imgQueryModelTrainStatus | 个性化文生图/模型训练状态查询 | 个性化文生图/模型训练状态查询。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| AliyunConsoleOpenApiQueryAliyunConsoleServcieList | 开放的服务能力列表 | 阿里云控制台/列出阿里云控制台上可使用的服务列表。 |
| CountOralEvaluationStatisticsConcurrent | 口语评测服务并发数统计 | 智能批改/口语评测/统计/并发数 |
| CountOralEvaluationStatisticsCalls | 口语评测服务调用量查询 | 智能批改/口语评测/统计/调用量 |
| CountOralEvaluationStatisticsError | 口语评测服务错误码统计 | 智能批改/口语评测/统计/调用错误 |