Skip to main content
POST
/
v1
/
tools
/
kb
/
search
Search Knowledge Base
curl --request POST \
  --url https://api.reportify.cn/v1/tools/kb/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "folder_ids": [
    "<string>"
  ],
  "doc_ids": [
    "<string>"
  ],
  "start_date": "<string>",
  "end_date": "<string>",
  "num": 10
}
'
{
  "chunks": []
}

​
搜索知识库

URL: /v1/tools/kb/search
方法: POST
描述: 搜索用户的私有知识库，包括上传的文档和文件夹。

​
请求参数

参数名类型必填描述
querystring是搜索关键词
folder_idsstring[]否文件夹 ID 列表，筛选特定文件夹
doc_idsstring[]否文档 ID 列表，筛选特定文档
start_datestring否开始日期（YYYY-MM-DD）
end_datestring否结束日期（YYYY-MM-DD）
numinteger否返回结果数量，默认 10

​
响应参数

参数名类型描述
chunksarray搜索结果块列表
  chunk_idstring内容块 ID
  contentstring匹配的内容
  scorenumber相关性得分
  doc_idstring所属文档 ID
  doc_titlestring文档标题
  folder_idstring文件夹 ID
  folder_namestring文件夹名称

​
请求示例

cURL 
curl -X POST "https://api.reportify.cn/v1/tools/kb/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": "投资策略",
    "num": 10
  }'
Python 
import requests

url = "https://api.reportify.cn/v1/tools/kb/search"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}
data = {
    "query": "投资策略",
    "folder_ids": ["folder_abc123"],
    "num": 10
}

response = requests.post(url, headers=headers, json=data)
results = response.json()

for chunk in results["chunks"]:
    print(f"[{chunk['doc_title']}] {chunk['content'][:100]}...")
TypeScript 
const response = await fetch('https://api.reportify.cn/v1/tools/kb/search', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    query: '投资策略',
    num: 10
  })
});

const data = await response.json();
console.log(`Found ${data.chunks.length} results`);

​
响应示例

{
  "chunks": [
    {
      "chunk_id": "chunk_abc123",
      "content": "本报告提出的投资策略主要关注价值投资和成长投资的结合...",
      "score": 0.95,
      "doc_id": "doc_xyz789",
      "doc_title": "2024年投资策略报告.pdf",
      "folder_id": "folder_abc123",
      "folder_name": "投资研究"
    }
  ]
}

​
错误响应

状态码描述
422请求参数验证失败

​
使用场景

  1. 搜索私有文档
    • 在上传的研究报告中搜索特定内容
    • 快速定位相关分析和数据
  2. 按时间范围筛选
    • 搜索特定时间段内的文档内容
    • 追踪历史分析记录
  3. 分文件夹搜索
    • 在特定项目文件夹中搜索
    • 隔离不同研究领域的内容

Authorizations

​
Authorization
string
header
required

Enter your Bearer token

Body

application/json

Request model for knowledge base search

​
query
string
required

Search query

​
folder_ids
string[]

Folder IDs to filter by

​
doc_ids
string[]

Document IDs to filter by

​
start_date
string

Start date filter (YYYY-MM-DD)

​
end_date
string

End date filter (YYYY-MM-DD)

​
num
integer
default:10

Number of results to return

Response

Successful Response

Output model for knowledge base search

​
chunks
OAIChunkWithDoc · object[]

Search result chunks with document information