RunDocQa_AI妙笔_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

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

请求语法

POST /miaodu/stream/runDocQA HTTP/1.1

请求参数

字段名称字段详情
WorkspaceIdstring

百炼业务空间 Id

示例值:llm-dswd4003ny4gh9rw
SearchSourcestring

搜索源

示例值:fromWeb枚举值:fromIndexLibfromWebfromRefContentfromDoc参考取值来源:
    RunSearchGeneration
    SearchNews
DocIdsarray<string>

多个文档 Id 数组

Querystring

问题

示例值:苹果16手机什么时候发布
ReferenceContentstring

提问者主动提供的关联内容

示例值:关联内容
ConversationContextsarray<object>

历史上下文内容数组

SessionIdstring

对话 ID

示例值:f486c4e2-b773-4d65-88f8-2ba540610456
CategoryIdsarray<string>

过滤目录 Id 数组,只在 SearchSource 为 fromIndexLib 时有效

返回参数

字段名称字段详情
Headerobject

响应头

Payloadobject

响应体

RequestIdstring

请求 Id

示例值:1813ceee-7fe5-41b4-87e5-982a4d18cca5

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
403
NoPermission
You are not authorized to perform this action.诊断

变更历史

变更时间变更内容概要操作
2024-12-16
新增OpenAPI,文档问答(文章问答/多模态文件问答)

相关示例

2024年08月20日