Querying the FAQ List

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

repo_id

Yes

String

Definition:

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.

Constraints:

N/A

Value range:

Length: 1 to 64 characters. The value can contain only digits, letters, hyphens (-), and underscores (_).

Default value:

N/A

question

No

String

Definition:

Question keywords.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

answer

No

String

Definition:

The answer of an FAQ.

Constraints:

N/A

Value range:

The value cannot exceed 10,000 characters.

Default value:

N/A

page_num

No

Integer

Definition:

Page number of the current request, indicating the start page from data retrieval. The default value is 1, indicating to start from the first page.

Constraints:

N/A

Value range:

1-65535

Default value:

1

page_size

No

Integer

Definition:

Number of records displayed on each page, indicating the number of records returned per request. The default value is 10, indicating that 10 records are displayed on each page.

Constraints:

N/A

Value range:

1-65535

Default value:

10

ids

No

Array of strings

Definition:

FAQ ID list.

Constraints:

N/A

Value range:

Each ID can contain only 1 to 64 characters. Only digits, letters, hyphens (-), and underscores (_) are allowed.

Default value:

N/A

create_user

No

String

Definition:

Creator name

Constraints:

N/A

Value range:

The user name contains 1 to 64 characters.

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

records

Array of FaqInfo objects

Definition:

FAQ information.

Value range:

N/A

total

Integer

Definition:

Total number.

Value range:

N/A

size

Integer

Definition:

Number of records per page.

Value range:

N/A

current

Integer

Definition:

Current page number.

Value range:

N/A

optimize_count_sql

Boolean

Definition:

This parameter can be ignored.

Value range:

N/A

search_count

Boolean

Definition:

This parameter can be ignored.

Value range:

N/A

pages

Integer

Definition:

Total number of pages.

Value range:

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

Query succeeded.