RunQuickWriting - 快速写作

更新时间:
复制为 MD 格式

可直接输入写作指令,进行快速写作。

接口说明

接入说明:

  • 由于 OpenAPI 门户目前对 SSE 推理协议不兼容(无法直接调试),接口 SDK 方式调用示例请参考妙笔最佳实践文档。
  • 获取 Java 异步 SDK 的最新版本:请点击链接获取。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
aimiaobi:RunQuickWritingcreate
*全部资源
*

请求参数

名称类型必填描述示例值
WorkspaceIdstringxxxx
TaskIdstring

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

3f7045e099474ba28ceca1b4eb6d6e21
Articlesarray<object>

引用的文章

集合
object

文章对象

Titlestring

文章标题

文章标题
Contentstring

文章内容

文章内容
Urlstring

文章 URL

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

其他写作参数(prompt 和 writingParams 二选一)

请按英文输出
SearchSourcesarray<object>

使用指定的搜索源列表

object

搜索源对象

Codestring

SystemSearch:系统内置搜索,CustomSemanticSearch:自建语义索引搜索,ThirdSearch:三方 API 搜索

SystemSearch
DatasetNamestring

数据源唯一标识

QuarkCommonNews

返回参数

名称类型描述示例值
object

BaseLlmResponse

Headerobject

响应头

ErrorCodestring

错误码

错误码
ErrorMessagestring

错误信息

错误信息
Eventstring

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

task-started
SessionIdstring

会话 ID

3f7045e099474ba28ceca1b4eb6d6e21
StatusCodeinteger

http 响应码

400
TaskIdstring

任务 ID

3f7045e099474ba28ceca1b4eb6d6e21
TraceIdstring

全链路 ID

全链路ID
Payloadobject

响应体

Outputobject

输出

Textstring

文本生成结果

文本生成结果
Usageobject

Token 用量信息

InputTokenslong

输入使用的 Token 数量

78
OutputTokenslong

输出 Token 数量

34
TotalTokenslong

总 Token 数量

38
RequestIdstring

请求 ID

3f7045e099474ba28ceca1b4eb6d6e21
Endboolean

响应包是否结束

false

示例

正常返回示例

JSON格式

{
  "Header": {
    "ErrorCode": "错误码",
    "ErrorMessage": "错误信息",
    "Event": "task-started",
    "SessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "StatusCode": 400,
    "TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "TraceId": "全链路ID"
  },
  "Payload": {
    "Output": {
      "Text": "文本生成结果"
    },
    "Usage": {
      "InputTokens": 78,
      "OutputTokens": 34,
      "TotalTokens": 38
    }
  },
  "RequestId": "3f7045e099474ba28ceca1b4eb6d6e21",
  "End": false
}

错误码

HTTP status code错误码错误信息描述
403NoPermissionYou are not authorized to perform this action.请检查workspaceId的赋值

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

变更历史

变更时间变更内容概要操作
2025-12-04新增 OpenAPI查看变更详情