RunDocSmartCard - 妙读文档智能卡片

文档智能卡片接口

调试

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

授权信息

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

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

请求语法

POST /miaodu/stream/runDocSmartCard HTTP/1.1

请求参数

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

百炼工作空间 ID

llm-2setzb9x4ewsd
DocIdstring

文档 ID

84ufBYEeLMZOjRFo84HJ7ySL3Efr55
SessionIdstring

对话 ID

3f7045e099474ba28ceca1b4eb6d6e21

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

1813ceee-7fe5-41b4-87e5-982a4d18cca5
Headerobject

响应头

ErrorCodestring

错误码

success
ErrorMessagestring

错误信息

success
Eventstring

事件类型

finished
EventInfostring

事件描述

模型生成事件
SessionIdstring

通话唯一 ID

07181f55-2311-48af-8048-132a77dee020
TaskIdstring

任务 ID。

8d55b429d7c6d321fcff54823e8d317b
TraceIdstring

全链路 ID

0abb781c17337107444473701ed7c3
Payloadobject

响应体

Outputobject

输出内容对象

Contentstring

卡片标题

标题内容
Tagsarray

卡片标签数组

tagsstring

卡片标签

标签内容
Usageobject
InputTokenslong

输入使用的 Token 数量

1
OutputTokenslong

输出 Token 数量

100
TotalTokenslong

总 token 数量

101

示例

正常返回示例

JSON格式

{
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5",
  "Header": {
    "ErrorCode": "success",
    "ErrorMessage": "success",
    "Event": "finished",
    "EventInfo": "模型生成事件",
    "SessionId": "07181f55-2311-48af-8048-132a77dee020",
    "TaskId": "8d55b429d7c6d321fcff54823e8d317b",
    "TraceId": "0abb781c17337107444473701ed7c3"
  },
  "Payload": {
    "Output": {
      "Content": "标题内容",
      "Tags": [
        "标签内容"
      ]
    },
    "Usage": {
      "InputTokens": 1,
      "OutputTokens": 100,
      "TotalTokens": 101
    }
  }
}

错误码

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

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