表格问答

本文为您介绍获取知识库的内容,进行表格问答查询的表格问答接口。

前提条件

  • 获取身份鉴权API Key:调用OpenSearch-LLM智能问答版服务时,需要对调用者身份进行鉴权,具体请参见管理API Key

  • 获取服务调用地址:调用OpenSearch-LLM智能问答版服务时,需要提供服务的调用地址,具体请参见获取服务调用地址

接口信息

请求方法

请求协议

请求数据格式

POST

HTTP

JSON

请求URL

{host}/v3/openapi/apps/[app_group_identity]/actions/table-search

请求参数

Header参数

参数

类型

是否必填

描述

示例值

Content-Type

string

请求的数据格式,目前仅支持JSON格式,固定填写"application/json"。

application/json

Authorization

string

请求鉴权的API Key,Bearer开头。

Bearer OS-d1**2a

Body参数

参数

类型

是否必填

描述

示例值

question

string

用户问题。

测试问题

table_name

string

需要查询的数据表,和schema中的表保持一致。

table1

model

string

使用哪个大模型进行最后的问答总结。

order_columns

map<String, List<String>>

返回的数据根据指定字段进行排序,map key为表名,value为字段列表。

fuzzy_columns

array

需要模糊匹配的字段。

请求体示例

{
  "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。

响应体示例

{
	"request_id": "17030438251680205838****",
	"status": "OK",
	"latency": 2144.217381,
	"result": {
		"data": [
			{
				"answer": "问题答案",
				"type": "TEXT"
			}
		],
    "sql": "测试SQL"
	}
}