Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ APIs/ Defining Custom Document Parsing Rules/ Creating a Custom Parsing Rule
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Creating a Custom Parsing Rule

Function

This API is used to create user-defined parsing rules. The parsing rules are used to parse the text to be used as subtitles. The rules are verified from top to bottom.

URI

POST /v1/{project_id}/applications/{application_id}/uni-search/rule-regex

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

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

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
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

regexs

Yes

Array of strings

Definition:

Rule list. The size of regexs ranges from 1 to 10.

Constraints:

N/A

Value range:

The regexs size must be between 1 and 10.

Default value:

N/A

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

Rule ID.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Definition:

Error Code.

Value range:

N/A

error_msg

String

Definition:

Error message.

Value range:

N/A

Example Requests

Create a custom parsing rule.

/v1/{project_id}/applications/{application_id}/uni-search/rule-regex

{
  "regexs" : [ "string", "string" ]
}

Example Responses

Status code: 200

The creation is successful.

{
  "id" : "1777619994213965826"
}

Status Codes

Status Code

Description

200

The creation is successful.

400

Incorrect request body parameter.

500

Internal error.

Error Codes

See Error Codes.