妙搜-文搜文。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| aimiaobi:RunSearchSimilarArticles | none | *全部资源 * |
| 无 |
请求语法
POST /quanmiao/aimiaosou/runSearchSimilarArticles HTTP/1.1请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| WorkspaceId | string | 是 | 业务空间 ID | xxxx |
| ChatConfig | object | 否 | 通信配置参数 | |
| SearchParam | object | 否 | 搜索配置参数 | |
| SearchSources | array<object> | 否 | 搜索源 | |
| object | 否 | |||
| Code | string | 否 | 搜索源类型：
| SystemSearch |
| Name | string | 否 | 搜索源名称（非必选） | 互联网搜索 |
| DatasetName | string | 否 | 搜索源唯一标识 | QuarkCommonNews |
| Title | string | 否 | 文章标题 | 标题 |
| DocType | string | 否 | 文档类型 | html |
| Url | string | 是 | 文章地址 | https://xxx/xxx |
返回参数
示例
正常返回示例
JSON格式
{
"Header": {
"ErrorCode": "错误码",
"ErrorMessage": "错误信息",
"Event": "task-started",
"SessionId": "3f7045e099474ba28ceca1b4eb6d6e21",
"TaskId": "3f7045e099474ba28ceca1b4eb6d6e21"
},
"Payload": {
"Output": {
"Text": "文本生成结果",
"Articles": [
{
"DocUuid": "a26c2c1",
"SearchSourceName": "互联网搜索",
"PubTime": "2025-01-16 18:07:22",
"Source": "xxx.com",
"Title": "标题",
"Url": "https://xxx",
"Summary": "xxx",
"DocId": "xxx"
}
]
},
"Usage": {
"InputTokens": 81,
"OutputTokens": 9,
"TotalTokens": 50
}
},
"RequestId": "3f7045e099474ba28ceca1b4eb6d6e21"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 403 | NoPermission | You are not authorized to perform this action. | 请检查workspaceId的赋值 |
访问错误中心查看更多错误码。