Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ Outdated APIs/ Knowledge base management/ This API is used to set the general Q&A prompt.
Updated on 2025-08-13 GMT+08:00
View PDF
Share

This API is used to set the general Q&A prompt.

Function

This API is used to set the general Q&A prompt. The prompt contains the question placeholder {0} and the requirement for the answer.

URI

POST /v1/koosearch/repos/{repo_id}/common-prompt

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repo_id

Yes

String

Knowledge base ID. The value is a string of 1 to 64 characters and can contain only digits, letters, hyphens (-), and underscores (_).

How to obtain:

Log in to the KooSearch experience platform. In the navigation tree on the left, choose Knowledge Bases to view knowledge base IDs. Each knowledge base has a unique ID stored in the vector database.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication."

Constraints:

N/A.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

prompt

Yes

String

No search prompt is displayed.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

repo_id

String

Knowledge base ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Example Value

POST https://{endpoint}/v1/koosearch/repos/acd90739-2e22-4870-b2db-35018699b623/common-prompt

{
  "prompt" : "You are a Q&A assistant. Please answer the question based on the documents below. Before answering the question, please carefully evaluate whether the documents provided can answer the question. If the given documents are irrelevant to the question, answer \"Sorry, I can't answer this question\"; if they are relevant, answer the question based on these documents.\nDocuments provided:\n{0}\nQuestion: {1}\nPlease provide your answer after carefully consideration based on the requirements given.}"
}

Example Responses

Status code: 200

Sets the knowledge base ID of the common prompt.

{
  "repo_id" : "919e8b10-b0c4-4bcd-9d5a-8ebb69594514"
}

Status Codes

Status Code

Description

200

Sets the knowledge base ID of the common prompt.

400

Incorrect request body parameter

500

Internal error

Error Codes

See Error Codes.