Obtaining FAQs

Function

This interface is used to obtain FAQ details, including questions and answers, by ID.

URI

GET /v1/koosearch/repos/{repo_id}/faqs/{faq_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
faq_id	Yes	String	Project ID. It can contain 1 to 64 characters. Only numbers, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. How to obtain: Logging In to the KooSearch Experience Platform In the navigation tree on the left, choose KooSearch Document Q&A. Select the service to be purchased based on the name/ID and click Q&A in the Operation column. The KooSearch Document Q&A page is displayed. In the navigation pane, choose Knowledge Base Management. In the knowledge base list, click the ID of the target knowledge base. Click FAQ Management to view the FAQ list and obtain the ID of an FAQ.
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.

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	FAQ ID
repo_id	String	Knowledge base ID.
question	String	Question.
answer	String	Answer.
status	String	This parameter can be ignored.
create_time	String	Creation time.
update_time	String	Update time.
question1	String	Similar question 1
question2	String	Similar question 2
question3	String	Similar question 3
question4	String	Similar Question 4.
category	String	Directory, which is a single value and corresponds to the leaf node in the directory tree.
tags	Array of strings	Tag list. Notes: A document can have one or more tags. It is recommended that the tag value be case insensitive. Do not use reserved characters (+ - = && \|\| > <!). Otherwise, you will need to escape them in queries. ( ) { } [ ] ^ " ~ ? : \ /* The tag list must be replaced as a whole. Partial update is not supported.
component_num	Integer	Number of the shard where the document shard is located. The value is fixed to 0 in the FAQ scenario.
page_num	Integer	Number of the page where the shard is located in the document. The value is fixed to 0 in the FAQ scenario.

Example Requests

None

Example Responses

Status code: 200

A success message is displayed.

{
  "id" : "5323205cfa9244b385ff5968ece0cd9a",
  "repo_id" : "123",
  "question" : "Question",
  "answer" : "Answer",
  "status" : 0,
  "create_time" : "1716284755573",
  "update_time" : "1716284755573"
}