文档

RunTitleGeneration - 标题生成

更新时间:

妙笔:标题生成。

调试

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

授权信息

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

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

请求语法

POST /quanmiao/aimiaobi/runTitleGeneration

请求参数

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

业务空间 id,请登录百炼后,在左上角业务空间详情中获取。

llm-xxx
ReferenceDataobject

要生成标题的数据

Contentsarray

正文列表

string

正文

xxx
TaskIdstring

关联创作文章唯一标识

xxxx

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

状态码

AccessForbid
Headerobject

响应头

ErrorCodestring

错误码

AccessForbid
ErrorMessagestring

错误码消息。

xxx
Eventstring

SSE 事件。

task-failed
SessionIdstring

会话 ID

3f7045e099474ba28ceca1b4eb6d6e21
StatusCodeinteger

状态码。

400
TaskIdstring

任务 ID

50a1cc8e-717e-4a2b-a76b-dc9734a8564b
TraceIdstring

全链路 ID

0a3d448f17000139741898287e0eb3
HttpStatusCodestring

http 状态码

200
Messagestring

错误说明

数据不存在
Payloadobject

响应体

Outputobject

输出

Textstring

文章标题

xxx
Usageobject

token 用量

InputTokenslong

输入使用的 Token 数量

1
OutputTokenslong

输出使用的 Token 数量

1
TotalTokenslong

本次调用使用的所有 Token 数总和

2
RequestIdstring

请求唯一标识

94512A33-8EC1-5452-A793-5C91F18ED2F0
Successboolean

是否成功:true 成功,false 失败

true

示例

正常返回示例

JSON格式

{
  "Code": "AccessForbid",
  "Header": {
    "ErrorCode": "AccessForbid",
    "ErrorMessage": "xxx",
    "Event": "task-failed",
    "SessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "StatusCode": 400,
    "TaskId": "50a1cc8e-717e-4a2b-a76b-dc9734a8564b",
    "TraceId": "0a3d448f17000139741898287e0eb3"
  },
  "HttpStatusCode": "200",
  "Message": "数据不存在",
  "Payload": {
    "Output": {
      "Text": "xxx"
    },
    "Usage": {
      "InputTokens": 1,
      "OutputTokens": 1,
      "TotalTokens": 2
    }
  },
  "RequestId": "94512A33-8EC1-5452-A793-5C91F18ED2F0",
  "Success": true
}

错误码

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