Updated on 2025-08-13 GMT+08:00

Creating FAQ Document Chunks

Function

Create FAQ document chunks and save them to the database.

URI

POST /v1/{project_id}/applications/{application_id}/uni-search/faq/batch/{file_id}/docs

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

file_id

Yes

String

Definition:

File ID.

Constraints:

N/A

Value range:

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

Default value:

N/A

Request Parameters

Table 2 Request body parameters

Parameter

Mandatory

Type

Description

title

No

String

Definition:

Title.

Constraints:

N/A

Value range:

A maximum of 1,000 characters are allowed.

Default value:

N/A

content

Yes

String

Definition:

Content.

Constraints:

N/A

Value range:

The value cannot be empty and can contain a maximum of 10,000 characters.

Default value:

N/A

Response Parameters

Status code: 200

Creation succeeded.

None

Example Requests

Create FAQ document chunks.

/v1/ee51ecd9-bc3c-4e98-b7df-ba6647350af2/applications/01d3c218-4d37-489a-98ff-69d69ea44bb1/uni-search/faq/batch/5b361670-1b2c-436e-b805-595c56f5c8e4/docs/7246ccc1-d88d-409c-8e70-30ba08efdf1b_2

{
  "title" : "xxxxxxxxxxrxxxx",
  "content" : "yyyyyyyyyeyyyyyyyyy"
}

Example Responses

None

Status Codes

Status Code

Description

200

Creation succeeded.

Error Codes

See Error Codes.