Obtaining FAQs

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:

1. Log in to the KooSearch experience platform.

2. In the navigation tree on the left, choose KooSearch Document Q&A.

3. 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.

4. 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.

5. Click FAQ Management to view the FAQ list and obtain the required FAQ ID.

Value range:

N/A

repo_id

No

String

Definition:

Knowledge base ID. When carried in the request, it specifies the target knowledge base for the query.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

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

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.

1. A document can have more than one tag.

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.

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

200

FAQ details successfully obtained by ID.