Skip to content

Commit

Permalink
docs: 文档小细节
Browse files Browse the repository at this point in the history
  • Loading branch information
MistEO committed May 10, 2024
1 parent 1b036b4 commit 02b815c
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
6 changes: 4 additions & 2 deletions docs/en_us/3.1-PipelineProtocol.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand Down Expand Up @@ -338,10 +340,10 @@ This task property requires additional fields:
Same as `TemplateMatch`.`roi`.

- `expected`: *string* | *list<string, >*
The expected results, supports regular expressions. Required (unless set separately through the interface).
The expected results, supports regular expressions. Required.

- `text`: *string* | *list<string, >*
Deprecated, same as `expected`
Deprecated, same as `expected`.

- `replace`: *array<string, 2>* | *list<array<string, 2>>*
Some text recognition results may not be accurate, so replacements are performed. Optional.
Expand Down
8 changes: 5 additions & 3 deletions docs/zh_cn/3.1-任务流水线协议.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ Orange 的 next 中,
## 属性字段
**注:对于必选字段,Pipeline JSON 文件中仍可为空,并在实际执行前通过接口设置。**
- `recognition` : *string*
识别算法类型。可选,默认 `DirectHit`。
可选的值:`DirectHit` | `TemplateMatch` | `FeatureMatch` | `ColorMatch` | `OCR` | `NeuralNetworkClassify` | `NeuralNetworkDetect` | `Custom`
Expand Down Expand Up @@ -342,13 +344,13 @@ graph LR;
该任务属性需额外部分字段:
- `roi`: *array<int, 4>* | *list<array<int, 4>>*
同 `TemplateMatch`.`roi`
同 `TemplateMatch`.`roi`
- `expected`: *string* | *list<string, >*
期望的结果,支持正则。必选(除非通过接口单独设置)
期望的结果,支持正则。必选。
- `text`: *string* | *list<string, >*
已废弃,同 `expected`
已废弃,同 `expected`
- `replace`: *array<string, 2>* | *list<array<string, 2>>*
部分文字识别结果不准确,进行替换。可选。
Expand Down

0 comments on commit 02b815c

Please sign in to comment.