文档

RunStepByStepWriting - 分步骤写作

更新时间:

使用大纲+摘编的分步骤的模式进行写作

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求语法

POST /quanmiao/miaobi/runStepByStepWriting

请求参数

名称类型必填描述示例值
WorkspaceIdstring

业务空间 ID

xxxx
Promptstring

提示词

提示词
TaskIdstring

任务 ID,多轮对话可复用同一轮任务 ID

3f7045e099474ba28ceca1b4eb6d6e21
SessionIdstring

单轮对话的 ID

3f7045e099474ba28ceca1b4eb6d6e21
OriginSessionIdstring

重新生成时原始对话的 ID

3f7045e099474ba28ceca1b4eb6d6e21
WritingConfigobject

写作配置

Domainstring

写作领域:media(默认):传媒写作,government:公文写作

media
Keywordsarray

关键词(影响文章检索)

string

关键词(string)

关键词
PromptTagobject

提示词小助手

NecessaryTipsstring

必要提示

必要提示
Positionstring

立场

立场
ReverseWordsstring

反向词

反向词
Themestring

主题

主题
Scenestring

分步骤写作场景,传媒写作支持的写作场景:新闻写作(默认),新闻评论,通用文体,公文写作支持的写作场景:通知(默认),通告,通报,请示,决定,函,通用文体

分步骤写作场景,传媒写作支持的写作场景:新闻写作(默认),新闻评论,通用文体,公文写作支持的写作场景:通知(默认),通告,通报,请示,决定,函,通用文体
Stepstring

写作步骤-生成大纲:OutlineGenerate、生成摘编:MiniDocSummary,Writing(默认):生成文章

Writing
Tagsarray<object>

写作时的文体、篇幅、输出语言等控制参数

object

标签对象

Keywordstring

选项的值

10
Tagstring

选项的 Tag。例如 gcNumberSizeTag=10

gcNumberSizeTag
UseSearchboolean

是否自动补充素材

true
ReferenceDataobject

写作时的参考文章数据

Articlesarray<object>

写作时的参考文章数据

object

写作时的参考文章数据

Authorstring

作者

作者
Contentstring

内容

文章内容
DocIdstring

文档-自定义的唯一 ID

文档-自定义的唯一ID
DocUuidstring

内部文档唯一标识

8a20e007a6174522af4d6a2657d5526f
MediaUrlstring

原始素材地址

http://www.example.com
PubTimestring

发布时间

2024-09-10 14:17:54
Sourcestring

来源

央视网
Summarystring

文章摘要

文章摘要
Tagstring

标签

文章标签
Titlestring

标题

文章标题
Urlstring

文章 URL

https://www.example.com/aaa.docx
MiniDocarray

排序 Rank 后的文章片段(用于后续模型生成)

string

文章片段

文章片段
Outlinesarray<object>

大纲(可以指定数据源生成大纲)

object

大纲

Articlesarray<object>

指定大纲数据源

object

文章对象

Contentstring

文章内容

文章内容
Titlestring

文章标题

文章标题
Urlstring

文章链接

文章链接
Outlinestring

大纲

大纲
Summarizationarray

大模型摘编总结结果

string

摘编结果(模型上下文)

摘编结果(模型上下文)

返回参数

名称类型描述示例值
object

BaseLlmResponse

Headerobject

响应头

ErrorCodestring

错误码

错误码
ErrorMessagestring

错误信息

错误信息
Eventstring

SSE 事件。task-started:开始,task-finished:结束,task-failed:失败

task-started
OriginSessionIdstring

父会话 ID

3f7045e099474ba28ceca1b4eb6d6e21
SessionIdstring

会话 ID

3f7045e099474ba28ceca1b4eb6d6e21
TaskIdstring

任务 ID

3f7045e099474ba28ceca1b4eb6d6e21
TraceIdstring

全链路 ID

全链路ID
Payloadobject

响应体

Outputobject

输出

Articlesarray<object>

参照文章

object

参照文章

Authorstring

作者

作者
Contentstring

内容

文章内容
DocIdstring

文档-自定义的唯一 ID

文档-自定义的唯一ID
DocUuidstring

内部文档唯一标识

f1da53894e784759946d22e2cb2b522a
MediaUrlstring

原始素材地址

http://www.example.com
PubTimestring

发布时间

2024-09-10 14:17:53
Sourcestring

来源

央视网
Summarystring

文章摘要

文章摘要
Tagstring

标签

文章标签
Titlestring

标题

文章标题
Urlstring

文章 URL

https://www.example.com/aaa.docx
ExtraOutputobject

额外输出字段

summarizationarray

摘编列表(分步骤生成摘编时,会返回该字段)

string

摘编字段

摘编
MiniDocarray

文章精排之后的片段列表

string

文章精排之后的片段 *

文章精排之后的片段
SearchQuerystring

query 改写结果

大模型改变世界
Textstring

文本生成结果

文本生成结果
Usageobject

Token 用量信息

InputTokenslong

输入 Token 数

65
OutputTokenslong

输出 Token 数

80
TotalTokenslong

总 Token 数

32
RequestIdstring

唯一请求 ID

3f7045e099474ba28ceca1b4eb6d6e21

示例

正常返回示例

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"
}

错误码

访问错误中心查看更多错误码。