Updated on 2025-08-13 GMT+08:00

Updated FAQs.

Function

This API is used to update questions, answers, and similar questions of an FAQ with a specified ID.

URI

PUT /v1/koosearch/repos/{repo_id}/faqs

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

id

Yes

String

Confidence

question

Yes

String

Question.

answer

Yes

String

Answer.

repo_id

No

String

Knowledge base ID.

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.

question1

No

String

Similar questions

question2

No

String

Similar questions

question3

No

String

Similar questions

question4

No

String

Similar questions

file_id

Yes

String

Document ID

category

No

String

Directory, which is a single value and corresponds to the leaf node in the directory tree.

tags

No

String

Tag list. Separate multiple tags by commas (,).

Notes:

  1. A document can have one or more tags.

  2. It is recommended that the tag value be case insensitive.

  3. Do not use reserved characters (+ - = && || > <!). Otherwise, you will need to escape them in queries. ( ) { } [ ] ^ " ~ * ? : \ /.

  4. The tag list must be replaced as a whole. Partial update is not supported.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

faq_id

String

ID of the FAQ to be updated.

Example Requests

None

Example Responses

Status code: 200

Updated

{
  "faq_id" : "64b4a1bc-3e60-43dd-981c-d24828ddc8ac"
}

Status Codes

Status Code

Description

200

Updated

Error Codes

See Error Codes.