RunDocQa - 文档问答_大模型服务平台百炼(Model Studio)-阿里云帮助中心

妙读问答接口

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
aimiaobi:RunDocQa	get	全部资源 ``	无	无

请求语法

POST /miaodu/stream/runDocQA HTTP/1.1

请求参数

名称	类型	必填	描述	示例值
WorkspaceId	string	是	百炼业务空间 Id	llm-dswd4003ny4gh9rw
SearchSource	string	是	搜索源枚举值： fromIndexLib：基于整个文档库进行问答。 fromWeb：基于互联网搜索进行问答。 fromRefContent：基于ReferenceContent字段进行问答。 fromDoc：基于给出的文档Id进行文档问答。	fromWeb
DocIds	array	否	多个文档 Id 数组
	string	否	文档 Id	10022
Query	string	是	问题	苹果16手机什么时候发布
ReferenceContent	string	否	提问者主动提供的关联内容	关联内容
ConversationContexts	array<object>	否	历史上下文内容数组
	object	否	历史上下文
Content	string	否	问答内容	问答内容
Role	string	否	角色	user
SessionId	string	是	对话 ID	f486c4e2-b773-4d65-88f8-2ba540610456
CategoryIds	array	否	过滤目录 Id 数组，只在 SearchSource 为 fromIndexLib 时有效
	string	否	类目 ID	default

返回参数

名称	类型	描述	示例值
	object	Schema of Response
Header	object	响应头
ErrorCode	string	错误码	success
ErrorMessage	string	错误信息	success
Event	string	事件	task-started
EventInfo	string	事件描述	模型生成事件
SessionId	string	会话 ID	f5517ee8-dbec-4dc8-bd0a-af084b5e3db1
TaskId	string	任务 id	3f7045e099474ba28ceca1b4eb6d6e21
TraceId	string	全链路 ID	46e5c2b5-0877-4f09-bd91-ab0cf314e48b
Payload	object	响应体
Output	object	输出
Content	string	回答内容	回答内容
InterveneContent	string	干预后的回答内容	干预后的回答内容
IsReject	boolean	是否拒识	false
MediaUrlList	array<object>	多模态资源信息列表
mediaUrlList	object	多模态资源对象
ClipInfos	array<object>	相关视频时间信息数组
clipInfos	object	相关视频时间信息
From	double	视频片段开始时间	0
To	double	视频片段结束时间	30
FileUrl	string	文件 url	https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg
MediaType	string	媒资媒体类型	video
Recommends	array<object>	推荐内容数组
recommends	object	推荐内容
Title	string	推荐内容标题	标题内容
Url	string	推荐内容 url	推荐内容url
References	array<object>	回答内容来源数组
references	object	回答内容来源
PubTime	string	发布时间	2024-10-08 18:00
Source	string	来源	新浪新闻
SourceDocId	string	来源 docId	123456
Title	string	关联内容标题	标题内容
Url	string	文章 URL	http://xxxxx
Usage	object	token 用量
InputTokens	long	输入 Token 数量	100
OutputTokens	long	输出使用的 Token 数量	100
TotalTokens	long	总 token 数量	200
RequestId	string	请求 Id	1813ceee-7fe5-41b4-87e5-982a4d18cca5

示例

正常返回示例

JSON格式

{
  "Header": {
    "ErrorCode": "success",
    "ErrorMessage": "success",
    "Event": "task-started",
    "EventInfo": "模型生成事件",
    "SessionId": "f5517ee8-dbec-4dc8-bd0a-af084b5e3db1",
    "TaskId": "3f7045e099474ba28ceca1b4eb6d6e21",
    "TraceId": "46e5c2b5-0877-4f09-bd91-ab0cf314e48b"
  },
  "Payload": {
    "Output": {
      "Content": "回答内容",
      "InterveneContent": "干预后的回答内容",
      "IsReject": false,
      "MediaUrlList": [
        {
          "ClipInfos": [
            {
              "From": 0,
              "To": 30
            }
          ],
          "FileUrl": "https://gw.alicdn.com/imgextra/i3/2775676850/O1CN01kdeffE20TM0E7wvpq_!!2775676850.jpg_q60.jpg",
          "MediaType": "video"
        }
      ],
      "Recommends": [
        {
          "Title": "标题内容",
          "Url": "推荐内容url"
        }
      ],
      "References": [
        {
          "PubTime": "2024-10-08 18:00",
          "Source": "新浪新闻",
          "SourceDocId": "123456",
          "Title": "标题内容",
          "Url": "http://xxxxx"
        }
      ]
    },
    "Usage": {
      "InputTokens": 100,
      "OutputTokens": 100,
      "TotalTokens": 200
    }
  },
  "RequestId": "1813ceee-7fe5-41b4-87e5-982a4d18cca5"
}

错误码

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

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