Skip to main content
GET
/
user
/
document
/
{knowledge_id}
/
settings
/
search
Get Document Search Settings
curl --request GET \
  --url https://api.example.com/user/document/{knowledge_id}/settings/search \
  --header 'Authorization: Bearer <token>'
{
  "knowledge_id": 123,
  "top_k": 123,
  "min_score": "<string>",
  "score_type": "<string>",
  "reranker_enabled": true,
  "reranker_top_n": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "reranker_model": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
knowledge_id
integer
required
Required range: x >= 1

Response

Successful Response

​
knowledge_id
integer
required
​
top_k
integer
required
​
min_score
string
required
Pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
​
score_type
string
required
​
reranker_enabled
boolean
required
​
reranker_top_n
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
reranker_model
string | null