检索增强生成

URL

/v3/openapi/apps/$app_name/rag?fetch_fields=name&query=config=format:fulljson&&query=name:'opensearch'&&sort=id&&raw_query="opensearch"&&chat={"name":"chat_test","prompt_parameters":{"param":"value"}}

• $app_name：表示应用名（高级版/标准版是多应用版本类型，需要指定应用名访问，主要针对服务中的应用版本，如填写线下应用ID可访问线下应用搜索服务）。

  

• 以上 URL 省略了请求Header参数及编码等因素。

• 以上 URL 中省略了访问应用的 host 地址。

• 以上URL 中拼接的所有查询参数，请查看下方“查询参数”的参数定义、使用方式及样例。

请求参数

查询参数具体拼接规则，详情请参见V3版API签名机制文档。

此处重点介绍与rag接口相关的参数，其余参数与搜索处理search接口一致。

请求示例

http://host/v3/openapi/apps/$app_name/rag?fetch_fields=name&query=config=format:fulljson&&query=name:'opensearch'&&sort=id&&raw_query="opensearch"&&chat={"name":"chat_test","prompt_parameters":{"param":"value"}}

返回结果

采用流式输出返回：

1. 首次只返回搜索结果，同search接口。

   {
     "status": "OK",
     "request_id": "c7e8c3fc1d3886050d7a58fee19964ca",
     "result": {
       "searchtime": 0.02588,
       "total": 1,
       "num": 1,
       "viewtotal": 1,
       "compute_cost": [
       ],
       "items": [{...}],
       "facet": []
     }
   }

2. 中间只返回对话内容，搜索result为空。

   {
     "status": "OK",
     "request_id": "c7e8c3fc1d3886050d7a58fee19964ca",
     "result": {},
     "chat": {
       "text": "",
     }
   }

3. 最后返回全部内容，包括渲染后的prompt。

   {
     "status": "OK",
     "request_id": "c7e8c3fc1d3886050d7a58fee19964ca",
     "result": {
       "searchtime": 0.02588,
       "total": 1,
       "num": 1,
       "viewtotal": 1,
       "compute_cost": [
       ],
       "items": [{...}],
       "facet": []
     },
     "chat": {
       "text": "",
       "prompt": ""
     }
   }

返回参数

错误码