Obtaining FAQs

Function

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

URI

GET /v1/{project_id}/applications/{application_id}/uni-search/faq/{faq_id}

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Definition: Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints: N/A Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
application_id	Yes	String	Definition: Application ID. For details about how to obtain the application ID, see Obtaining an Application ID. Constraints: Character string Value range: The value can contain 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed. The value must start with a letter. Default value: N/A
faq_id	Yes	String	Definition: FAQ 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: Log 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 on the left, choose Knowledge Base Management. In the knowledge base list, select the target knowledge base and click its ID. Click FAQ Management to view the FAQ list and obtain the required FAQ ID. Value range: N/A

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	Definition: Token used for API authentication. For details about how to obtain the token, see Obtaining an IAM User Token. Constraints: N/A Value range: N/A Default value: N/A

Response Parameters

Status code: 200

**Table 3** Response body parameters
Parameter	Type	Description
id	String	Definition: FAQ ID. Value range: N/A
repo_id	String	Definition: Knowledge base ID. Value range: N/A
question	String	Definition: Question. Value range: N/A
answer	String	Definition: Answer. Value range: N/A
status	String	Definition: This parameter can be ignored. Value range: N/A
create_user	String	Definition: Creator. Value range: N/A
create_time	String	Definition: Creation time. Value range: N/A
update_time	String	Definition: Update time. Value range: N/A
question1	String	Definition: Similar question 1. Value range: N/A
question2	String	Definition: Similar question 2. Value range: N/A
question3	String	Definition: Similar question 3 Value range: N/A
question4	String	Definition: Similar question 4. Value range: N/A
category	String	Definition: Directory, which is a single value and corresponds to a leaf node in the directory tree. Value range: N/A
tags	Array of strings	Definition: Tag list. A document can have more than one tag. 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. Value range: N/A
file_id	String	Definition: File ID. Value range: N/A
project_id	String	Definition: Project ID. Value range: N/A
component_num	Integer	Definition: Chunk sequence number Value range: N/A
page_num	Integer	Definition: Number of pages. Value range: N/A

Example Requests

Obtain FAQ details by ID.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/0c3fae2d-428e-454c-ad80-2e5c5fa7b33a/faq?page_num=1&page_size=10&repo_id=0c3fae2d-428e-454c-ad80-2e5c5fa7b33a

Example Responses

Status code: 200

FAQ details successfully obtained by ID.

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