智能写作
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:RunWritingV2 | create | *全部资源 * |
| 无 |
请求语法
POST /quanmiao/aimiaobi/runWritingV2 HTTP/1.1
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 业务空间 ID | xxxx |
| TaskId | string | 否 | 任务 ID，多轮对话可复用同一轮任务 ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| SessionId | string | 否 | 单轮对话的 ID | 3f7045e099474ba28ceca1b4eb6d6e21 |
| WritingScene | string | 否 | 写作场景（government:政务、media:传媒、market:营销，office：办公,custom:自定义） | media |
| WritingStyle | string | 否 | 写作文体 | 新闻评论 |
| DistributeWriting | boolean | 否 | 是否为分步骤写作 | false |
| PromptMode | string | 否 | 模板类型（Template:模板模式, PE：高级 PE 模式） | Template |
| Step | string | 否 | 分步骤写作步骤：OutlineGenerate:大纲生成、MiniDocSummary:摘编、Writing:写作 | Writing |
| Articles | array<object> | 否 | 引用的文章 | |
| object | 否 | 文章对象 | ||
| Title | string | 否 | 文章标题 | 文章标题 |
| Content | string | 否 | 文章内容 | 文章内容 |
| Url | string | 否 | 文章 URL | https://www.example.com/aaa.docx |
| Source | string | 否 | 文章来源 | 新华社 |
| SearchSourceName | string | 否 | 搜索信源 | QuarkCommonNews |
| PubTime | string | 否 | 发布时间 | 2024-11-25 14:25:59 |
| GcNumberSizeTag | string | 否 | 文章篇幅（300 字左右、600 字左右、1000 字左右、2000 字左右等） | 2000字左右 |
| GcNumberSize | integer | 否 | 写作的篇数（多篇按照不同的 sessionId 同时返回） | 2 |
| Language | string | 否 | 文章输出语言（en:英文，zh:中文） | en |
| Keywords | array | 否 | 关键词列表（会参与到检索与写作） | |
| string | 否 | 关键词（会参与到检索与写作） | 关键词 | |
| Prompt | string | 否 | 其他写作参数（prompt 和 writingParams 二选一） | 提示词 |
| WritingParams | object | 否 | 写作提示词（prompt 和 writingParams 二选一） | |
| string | 否 | 模板写作参数 | 模板写作参数 | |
| Outlines | array<object> | 否 | 大纲列表（分步骤接口使用） | |
| object | 否 | 大纲对象 | ||
| Outline | string | 否 | 大纲 | 大纲 |
| Articles | array<object> | 否 | 大纲重点参考的文章列表 | |
| object | 否 | 大纲重点参考的文章 | ||
| Title | string | 否 | 标题 | 标题 |
| Content | string | 否 | 正文内容 | 正文内容 |
| Url | string | 否 | 文章 URL | 文章URL |
| Summarization | array<object> | 否 | 摘编对象列表（分步骤接口使用） | |
| object | 否 | 摘编对象 | ||
| Event | string | 否 | 事件名称 | 事件名称 |
| Message | string | 否 | 事件摘编 | 事件摘编 |
| MiniDocs | array<object> | 否 | 文章片段列表 | |
| object | 否 | 文章片段对象 | ||
| Content | string | 否 | 片段内容 | 片段内容 |
| Star | boolean | 否 | 是否重点考虑该片段 | true |
| Index | string | 否 | 文章片段在引用文章中的索引 | 索引 |
| UseSearch | boolean | 否 | 是否使用搜索 | true |
| SearchSources | array<object> | 否 | 使用指定的搜索源列表 | |
| object | 否 | 搜索源对象 | ||
| Code | string | 否 | SystemSearch：系统内置搜索，CustomSemanticSearch：自建语义索引搜索，ThirdSearch：三方 API 搜索 | SystemSearch |
| Name | string | 否 | 搜索源描述 | 互联网搜索 |
| DatasetName | string | 否 | 数据源唯一标识 | QuarkCommonNews |
返回参数
示例
正常返回示例
JSON格式
{
"Header": {
"ErrorCode": "错误码",
"ErrorMessage": "错误信息",
"Event": "task-started",
"OriginSessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
"SessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
"StatusCode": 400,
"TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
"TraceId": "全链路ID"
},
"Payload": {
"Output": {
"Articles": [
{
"Author": "作者",
"Content": "文章内容",
"DocId": "文档-自定义的唯一ID",
"DocUuid": "98229f6001cf4deeb1668191d4eccc75",
"PubTime": "2024-08-28 11:38:28",
"Source": "央视网",
"Summary": "文章摘要",
"Tag": "文章标签",
"Title": "文章标题",
"Url": "https://www.example.com/aaa.docx"
}
],
"MiniDoc": [
"文章精排之后的片段"
],
"SearchQuery": "大模型改变世界",
"Text": "文本生成结果"
},
"Usage": {
"InputTokens": 78,
"OutputTokens": 34,
"TokenMap": {
"key": 44
},
"TotalTokens": 38
}
},
"RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
"End": true
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | 请检查workspaceId的赋值 |
访问错误中心查看更多错误码。