知识库文本查询 - 聆思API参考文档

请求参数

Query 参数

index_id

string

知识库id

可选

示例值:

0e5afc081c2f131449278bf2def74c98

content

string

查询文本

可选

示例值:

语音课程

limit

integer

显示结果条数

可选

示例值:

3

is_query_reference

string

可选

默认false，true表示查询，false表示不查询。另外，当此参数开启后，返回的数据会大于limit数量。

示例值:

false

Header 参数

Content-Type

string

可选

示例值:

application/json

Authorization

string

可选

示例值:

Bearer {{token}}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request GET 'https://api.listenai.com/v1/knowledge-bases/{{index_id}}/query?index_id=0e5afc081c2f131449278bf2def74c98&content=语音课程&limit=3&is_query_reference=false' \
--header 'Authorization: Bearer {{token}}' \
--header 'Content-Type: application/json'

返回响应

🟢200成功

application/json

Body

data

array [object {7}]

必需

id

string

知识点ID

必需

text

string

知识点文本内容

必需

doc_id

string

文档ID

必需

doc_name

string

文档名称

必需

score

number

命中分数

必需

分数范围 0～1

main_node_id

string

关联的主知识点ID

可选

若此参数存在，表示该知识点是关联查询的上下文知识点。

node_index

integer

知识点序号

必需

文档提取的知识点是有序，此参数表示知识点的序列编号。

message

string

必需

示例

{
  "message": "成功",
  "data": [
    {
      "id": "sadfaf95-a13b-4281-b582-acb44sddfsdf5b",
      "text": "一、关于购买进阶课顾虑   Q1：学习是在群里学吗？（学习的形式）A1：是的，是语音课程的形式，每天15分钟左右，加上作业大概花20分钟，有不懂的问题，老师和助教会在群里答疑",
      "doc_id": "0e5afc081c2f131449278bf2def74c98",
      "doc_name": "说明书.docx",
      "score": 0.2775,
      "main_node_id": "",
      "node_index": 20,
    },
    {
      "id": "20d1af95-a13b-4281-b582-acb44406a85b",
      "text": "一、关于购买进阶课顾虑   Q1：学习是在群里学吗？（学习的形式）A1：是的，是语音课程的形式，每天15分钟左右，加上作业大概花20分钟，有不懂的问题，老师和助教会在群里答疑",
      "doc_id": "0e5afc081c2f131449278bf2def74c98",
      "doc_name": "说明书.docx",
      "score": 0.2775,
      "main_node_id": "sadfaf95-a13b-4281-b582-acb44sddfsdf5b",
      "node_index": 21,
    }
  ]
}