Help Center/ Cloud Search Service_KooSearch/ API Reference/ API/ Outdated APIs/ Definition of user document parsing rules/ Modifying a User-Defined Parsing Rule
Updated on 2025-08-13 GMT+08:00
View PDF
Share

Modifying a User-Defined Parsing Rule

Function

Used to modify a user-defined parsing rule.

URI

PUT /v1/koosearch/rule-regex/{id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

id

Yes

String

User-defined parsing rule ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Parameter description:

Token used for API authentication. For how to obtain the token, see section 3.2 "Authentication."

Constraints:

N/A.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

regexs

Yes

Array of strings

Rule list

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

id

String

ID of the modified rule.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Example

GET https://{endpoint}/v1/koosearch/rule-regex/1777619994213965826

{
  "regexs" : [ "^(\\d+)\\s*[\\u4e00-\\u9fa5]+$", "^(\\d+)(\\.\\d+)\\s*[\\u4e00-\\u9fa5]+$", "^(\\d+)(\\.\\d+)(\\.\\d+)\\s*[\\u4e00-\\u9fa5]+$" ]
}

Example Responses

Status code: 200

Successful.

{
  "id" : "1777619994213965826"
}

Status Codes

Status Code

Description

200

Successful.

400

Incorrect request body parameter

500

Internal error

Error Codes

See Error Codes.