Uploading FAQs in Batches

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

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

file

Yes

File

Definition:

Upload documents.

Constraints:

Only files in XLSX, XLS, DOCX, or DOC format are supported. The maximum size of a single file is 128 MB. For details about the file content, see the Excel or Word sample. An Excel document can contain a maximum of 100,000 records. Blank lines are not allowed because any data following a blank line will be ignored. If the document size exceeds 60 MB, you are advised to upload it via an API.

Value range:

N/A

Default value:

N/A

rule

No

String

Definition:

Question matching rule.

Constraints:

N/A

Value range:

N/A

Default value:

N/A

file_id

String

Definition:

Document ID.

Value range:

N/A

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

200

Response body of the API for uploading documents.

400

Invalid parameter.

500

Internal error.