使用大纲+摘编的分步骤的模式进行写作。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:RunStepByStepWriting | create | *全部资源 * |
| 无 |
请求语法
POST /quanmiao/miaobi/runStepByStepWriting HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 业务空间 ID | xxxx |
| Prompt | string | 是 | 提示词 | 提示词 |
| TaskId | string | 否 | 任务 ID，多轮对话可复用同一轮任务 ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| SessionId | string | 否 | 单轮对话的 ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| OriginSessionId | string | 否 | 重新生成时原始对话的 ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| WritingConfig | object | 否 | 写作配置 | |
| Domain | string | 否 | 写作领域
| media |
| Keywords | array | 否 | 关键词(影响文章检索) | |
| Keyword | string | 否 | 关键词（string） | 关键词 |
| PromptTag | object | 否 | 提示词小助手 | |
| NecessaryTips | string | 否 | 必要提示 | 必要提示 |
| Position | string | 否 | 立场 | 立场 |
| ReverseWords | string | 否 | 反向词 | 反向词 |
| Theme | string | 否 | 主题 | 主题 |
| Scene | string | 否 | 分步骤写作场景
| 新闻写作 |
| Step | string | 否 | 写作步骤
| Writing |
| Tags | array<object> | 否 | 写作时的文体、篇幅、输出语言等控制参数 | |
| Tag | object | 否 | 标签对象 | |
| Keyword | string | 否 | 选项的值 | 10 |
| Tag | string | 否 | 选项的 Tag。例如 gcNumberSizeTag=10 | gcNumberSizeTag |
| UseSearch | boolean | 否 | 是否自动补充素材 | true |
| ReferenceData | object | 否 | 写作时的参考文章数据 | |
| Articles | array<object> | 否 | 写作时的参考文章数据 | |
| Article | object | 否 | 写作时的参考文章数据 | |
| Author | string | 否 | 作者 | 作者 |
| Content | string | 否 | 内容 | 文章内容 |
| DocId | string | 否 | 文档-自定义的唯一 ID | 文档-自定义的唯一ID |
| DocUuid | string | 否 | 内部文档唯一标识 | 8a20e007a6174522af4d6a2657d5526f |
| MediaUrl | string | 否 | 原始素材地址 | http://www.example.com |
| PubTime | string | 否 | 发布时间 | 2024-09-10 14:17:54 |
| Source | string | 否 | 来源 | 央视网 |
| Summary | string | 否 | 文章摘要 | 文章摘要 |
| Tag | string | 否 | 标签 | 文章标签 |
| Title | string | 否 | 标题 | 文章标题 |
| Url | string | 否 | 文章 URL | https://www.example.com/aaa.docx |
| MiniDoc | array | 否 | 排序 Rank 后的文章片段（用于后续模型生成） | |
| MiniDoc | string | 否 | 文章片段 | 文章片段 |
| Outlines | array<object> | 否 | 大纲（可以指定数据源生成大纲） | |
| Outline | object | 否 | 大纲 | |
| Articles | array<object> | 否 | 指定大纲数据源 | |
| Article | object | 否 | 文章对象 | |
| Content | string | 否 | 文章内容 | 文章内容 |
| Title | string | 否 | 文章标题 | 文章标题 |
| Url | string | 否 | 文章链接 | 文章链接 |
| Outline | string | 否 | 大纲 | 大纲 |
| Summarization | array | 否 | 大模型摘编总结结果 | |
| Summarization | string | 否 | 摘编结果（模型上下文） | 摘编结果（模型上下文） |
返回参数
示例
正常返回示例
JSON格式
{
"Header": {
"ErrorCode": "错误码",
"ErrorMessage": "错误信息",
"Event": "task-started",
"OriginSessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
"SessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
"TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
"TraceId": "全链路ID"
},
"Payload": {
"Output": {
"Articles": [
{
"Author": "作者",
"Content": "文章内容",
"DocId": "文档-自定义的唯一ID",
"DocUuid": "f1da53894e784759946d22e2cb2b522a",
"MediaUrl": "http://www.example.com",
"PubTime": "2024-09-10 14:17:53",
"Source": "央视网",
"Summary": "文章摘要",
"Tag": "文章标签",
"Title": "文章标题",
"Url": "https://www.example.com/aaa.docx"
}
],
"ExtraOutput": {
"summarization": [
"摘编"
]
},
"MiniDoc": [
"文章精排之后的片段"
],
"SearchQuery": "大模型改变世界",
"Text": "文本生成结果"
},
"Usage": {
"InputTokens": 65,
"OutputTokens": 80,
"TotalTokens": 32
}
},
"RequestId": "3f7045e099474ba28ceca1b4eb6d6e21"
}错误码
访问错误中心查看更多错误码。