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

Deleting FAQ Document Chunks

Function

Delete FAQ document chunks as well as database records.

URI

DELETE /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

file_doc_ids

Yes

Array of strings

Definition:

Document chunk ID list.

Constraints:

N/A

Value range:

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

Default value:

N/A

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

total

Long

Definition:

Number of records to be deleted.

Value range:

N/A

deleted

Long

Definition:

Number of records deleted.

Value range:

N/A

Example Requests

Delete FAQ document chunks.

/v1/b25446daeb1a41a7953c5deba2b2677a/applications/be9b19bf-4865-4fb8-b9f8-2fd1fea98d76/uni-search/faq/batch/79b50900-b29e-4865-8bd2-f0ace6656949/docs

[ "b29577d5-57d8-4e88-b995-0c4bd7303266_0" ]

Example Responses

Status code: 200

Batch deletion result.

{
  "total" : 1,
  "deleted" : 1
}

Status Codes

Status Code

Description

200

Batch deletion result.

Error Codes

See Error Codes.