URL
POST /v3/openapi/apps/{app_group_identity}/actions/table-search
说明
[app_group_identity]:表示应用名(需要指定应用名访问,主要针对服务中的应用版本)。
以上 URL 省略了请求Header参数及编码等因素。
以上 URL 中省略了访问应用的 host 地址。
请求头构建可参考:v3 API 签名机制
请求协议
HTTP
HTTP请求方式
POST
支持格式
JSON
查询参数
参数 | 类型 | 必需 | 取值范围 | 默认值 | 描述 |
question | String | 是 | 用户问题 | ||
table_name | String | 否 | 需要查询的数据表,和schema中的表保持一致。 | ||
model | String | 否 | opensearch-llama2-13b | 使用哪个大模型进行最后的问答总结,默认使用opensearch-llama2-13b | |
order_columns | Map<String, List<String>> | 否 | 返回的数据根据指定字段进行排序,map key为表名,value为字段列表 | ||
fuzzy_columns | Aaary | 否 | 需要模糊匹配的字段。 |
请求体示例:
{
"order_columns": {
"table1": [
{
"column": "column1",
"is_asc": false //true为正排,false为倒排
}
],
"table2": [
{
"column": "column2",
"is_asc": true
}
]
},
"question": "测试问题",
"table_name": "table1,table2",
"model": "模型名称",
"fuzzy_columns": [
"模糊字段1",
"模糊字段2"
]
}
返回结果
参数 | 类型 | 描述 | |
request_id | String | 请求ID | |
status | String | 请求状态 | |
latency | Float | 延迟时间 | |
answer | String | 问答结果 | |
type | String | 返回结果类型 | |
sql | Sql | 生成的SQL | 生成的SQL |
响应体示例:
{
"request_id": "170304382516802058384802",
"status": "OK",
"latency": 2144.217381,
"result": {
"data": [
{
"answer": "问题答案",
"type": "TEXT"
}
],
"sql": "测试SQL"
}
}
反馈
- 本页导读 (0)
文档反馈