CleverSee-垂域搜索 医疗问答 API

更新时间:
复制 MD 格式

调用 MedicalAnswer 接口,基于权威医疗数据返回结论型专业解答及其依据来源。

一、接口说明

接口名称:MedicalAnswer

能力说明:基于海量权威的医疗数据进行搜索,之后利用大模型能力进行汇总提炼,形成专业解答。相对于其他搜索引擎而言,返回结果更全面、更专业,也可以回答更广泛的口语化问题,例如「坐车恶心原因是什么」「肚子疼怎么办」「无糖可乐对身体好吗」。

计量方式为「联网搜索(Generic版)」,单价随当日该计量项落入的阶梯变化,阶梯规则详见 垂域搜索-计费说明。

说明

服务端超时时间为 5 秒 。

重要

医疗健康类内容仅供健康知识参考,不构成诊疗建议,不能替代执业医师的面诊与处方。

二、接口定义

请求参数

参数

类型

必填

默认值

描述

示例值

query

string

是

-

搜索问题。取值范围:1~200 个字符。基于效果考虑,建议将 query 控制在 30 个字符以内,可在调用接口前由客户侧通过模型做 Query 改写。

肚子疼怎么办

说明

长度与必填校验建议在客户侧完成:query 缺失或为空串时,接口返回 HTTP 200 且 messages 为空数组,不会返回错误码;query 超过 200 字符时也不会报错,但效果不保证。

返回参数

字段

类型

是否可空

字段说明

样例(Query:肚子疼怎么办)

requestId

string

不可空

请求 RequestId,排查问题时可以提供此信息

35E5608A-A737-2038-****-D9D34C6BFD9E

messages

list

可为空

解答列表。query 为空或未命中内容时返回空数组,客户侧需做空结果兜底

见下方示例

messages[].content

string

不可空

总结,即大模型汇总提炼后的专业解答,正文中的 [n] 为引用来源角标

肚子疼原因众多,缓解方法需结合具体病因和症状严重程度……

messages[].metaData.raDocList

list

可为空

依据来源列表。异常或超长 query 下可能返回空数组

见下方示例

messages[].metaData.raDocList[].title

string

不可空

依据来源标题。文献、图书、指南类来源以书名号包裹

怎么简单快速止肚子痛

messages[].metaData.raDocList[].rawUrl

string

可为空

依据来源链接。论文、诊疗指南、图书类来源该字段为空字符串

https://www.example.com/article/4CD364Mm8hh.html

messages[].metaData.raDocList[].content

string

可为空

依据来源内容摘要。仅医疗网页、药品说明书类来源返回摘要,文献与知识库类来源该字段为空字符串

肚子痛可能由多种原因引起,包括胃肠道痉挛、炎症……

messages[].metaData.raDocList[].type

string

不可空

依据来源类型。取值:med_web_source:医疗网页;book_source:医学图书;paper_source:论文;guide_source:诊疗指南;med_knowledge_source:医疗知识库;instructions_source:药品说明书;health_knowledge_source:健康知识库。取值可能随数据源扩展而新增,建议按未知值兜底处理。

med_web_source

searchInformation.searchTime

int64

不可空

搜索耗时,单位毫秒

342

queryContext.originalQuery.query

string

可为空

原始请求 query 的回显,请求未传 query 时返回 null

肚子疼怎么办

三、示例

请求参数(RequestBody)

{
  "query": "肚子疼怎么办"
}

返回参数

{
  "requestId": "ea42f9********1fa8",
  "messages": [
    {
      "content": "肚子疼原因众多,缓解方法需结合具体病因和症状严重程度。以下是一些常见缓解措施:1. **暂时停止进食**:若腹痛由饮食不当(如暴饮暴食、食用辛辣油腻食物)引起,可先暂停进食,让肠胃休息,避免进一步刺激[3][7]。2. **热敷或按摩腹部**:适用于轻度腹痛,如受凉或轻微消化不良导致的绞痛。",
      "metaData": {
        "raDocList": [
          {
            "title": "《如何有效缓解急性腹痛》",
            "rawUrl": "",
            "content": "",
            "type": "paper_source"
          },
          {
            "title": "怎么简单快速止肚子痛",
            "rawUrl": "https://www.example.com/article/4CD364Mm8hh.html",
            "content": "肚子痛可能由多种原因引起,包括胃肠道痉挛、炎症,泌尿系统结石,女性生理期疼痛等,可以通过腹部热敷舒缓、服用药物止痛等方法治疗。",
            "type": "med_web_source"
          },
          {
            "title": "《消化性溃疡基层诊疗指南(2023年) 治疗》",
            "rawUrl": "",
            "content": "",
            "type": "guide_source"
          },
          {
            "title": "《 常见症状 第十五节 腹痛》",
            "rawUrl": "",
            "content": "",
            "type": "book_source"
          }
        ],
        "mimeType": null
      }
    }
  ],
  "searchInformation": {
    "searchTime": 342
  },
  "queryContext": {
    "originalQuery": {
      "query": "肚子疼怎么办"
    }
  }
}

四、接口调用

使用产品的凭证(API-KEY)进行认证。API-KEY 在控制台「创建、查看凭证 Key」中创建, 创建后需等待约 5 分钟生效 。

curl -X POST https://cloud-iqs.aliyuncs.com/medical/answer \
  --header "Authorization: Bearer $API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
    "query": "肚子疼怎么办"
  }'

本接口仅提供 HTTP 直接调用,不提供阿里云 OpenAPI SDK。MCP / Skill 接入方式请参考「接入方式」章节。

五、错误码

调用失败时返回 HTTP 非 2xx 状态码,响应体为扁平结构。errorCode 与 errorMessage 恒定返回,部分错误会同时返回含义相同的 code 与 message 字段,解析时以 errorCode 为准:

{
  "errorCode": "Retrieval.EngineNotActivate",
  "errorMessage": "Please activate medicalKnowSearch.",
  "code": "Retrieval.EngineNotActivate",
  "message": "Please activate medicalKnowSearch."
}

Status

错误码

错误信息

处理方案

403

Retrieval.InvalidAPIKey

Incorrect APIKey provided.

检查 Authorization 头是否为 Bearer $API_KEY 格式、API-KEY 是否正确;新建的 API-KEY 需等待约 5 分钟生效。

403

Retrieval.EngineNotActivate

Please activate xxx.

凭证未开通该接口对应的搜索引擎,请联系您的客户经理开通。

403

Retrieval.NotActivate

Please activate AI search service

请下单或联系您的客户经理进行开通。

403

Retrieval.Arrears

Please recharge first.

账户金额不足,请充值。

403

Retrieval.NotAuthorised

Please authorize the AliyunIQSFullAccess privilege to the sub-account.

子账号没有进行授权,参考「创建 RAM 用户并授权」。

403

Retrieval.TestUserPeriodExpired

The test period has expired.

测试已到期(自下单后 15 天有效),可联系阿里云客户经理转正式。

429

Retrieval.Throttling.User

Request was denied due to user flow control.

超出限流规格,可联系阿里云客户经理进行升配。

429

Retrieval.TestUserQueryExceeded

The query exceed the limit

测试超出日限额(1000 次/天),可联系阿里云客户经理转正式。

相关文档