diff --git a/docs/en_us/3.1-PipelineProtocol.md b/docs/en_us/3.1-PipelineProtocol.md index da9d09cfb..eace76de5 100644 --- a/docs/en_us/3.1-PipelineProtocol.md +++ b/docs/en_us/3.1-PipelineProtocol.md @@ -61,6 +61,8 @@ This loop continues until the "next" of a task is empty, which signifies that th ## Property Fields +**Note: For required fields, they can still be empty in the Pipeline JSON file and set through the interface before actual execution.** + - `recognition`: *string* Recognition algorithm type. Optional, default is `DirectHit`. Possible values: `DirectHit` | `TemplateMatch` | `FeatureMatch` | `ColorMatch` | `OCR` | `NeuralNetworkClassify` | `NeuralNetworkDetect` | `Custom`. @@ -338,10 +340,10 @@ This task property requires additional fields: Same as `TemplateMatch`.`roi`. - `expected`: *string* | *list* - The expected results, supports regular expressions. Required (unless set separately through the interface). + The expected results, supports regular expressions. Required. - `text`: *string* | *list* - Deprecated, same as `expected` + Deprecated, same as `expected`. - `replace`: *array* | *list>* Some text recognition results may not be accurate, so replacements are performed. Optional. diff --git "a/docs/zh_cn/3.1-\344\273\273\345\212\241\346\265\201\346\260\264\347\272\277\345\215\217\350\256\256.md" "b/docs/zh_cn/3.1-\344\273\273\345\212\241\346\265\201\346\260\264\347\272\277\345\215\217\350\256\256.md" index 0fa2b60b0..a73fb2204 100644 --- "a/docs/zh_cn/3.1-\344\273\273\345\212\241\346\265\201\346\260\264\347\272\277\345\215\217\350\256\256.md" +++ "b/docs/zh_cn/3.1-\344\273\273\345\212\241\346\265\201\346\260\264\347\272\277\345\215\217\350\256\256.md" @@ -66,6 +66,8 @@ Orange 的 next 中, ## 属性字段 +**注:对于必选字段,Pipeline JSON 文件中仍可为空,并在实际执行前通过接口设置。** + - `recognition` : *string* 识别算法类型。可选,默认 `DirectHit`。 可选的值:`DirectHit` | `TemplateMatch` | `FeatureMatch` | `ColorMatch` | `OCR` | `NeuralNetworkClassify` | `NeuralNetworkDetect` | `Custom` @@ -342,13 +344,13 @@ graph LR; 该任务属性需额外部分字段: - `roi`: *array* | *list>* - 同 `TemplateMatch`.`roi` + 同 `TemplateMatch`.`roi`。 - `expected`: *string* | *list* - 期望的结果,支持正则。必选(除非通过接口单独设置)。 + 期望的结果,支持正则。必选。 - `text`: *string* | *list* - 已废弃,同 `expected` + 已废弃,同 `expected`。 - `replace`: *array* | *list>* 部分文字识别结果不准确,进行替换。可选。