ms-types 0.9.4 → 0.9.5

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "ms-types",
3
- "version": "0.9.4",
3
+ "version": "0.9.5",
4
4
  "type": "module",
5
5
  "license": "MIT",
6
6
  "publishConfig": {
@@ -121,17 +121,18 @@ declare namespace appleOcr {
121
121
  ): OCRResult[];
122
122
 
123
123
  /**
124
- * 执行OCR识别(查找指定文本)
124
+ * 执行OCR识别,在整段识别文本中查找指定子串
125
125
  * @param input 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
126
- * @param texts 要查找的文本数组
126
+ * @param texts 要查找的目标文本数组,可匹配识别结果中的子串
127
127
  * @param x 边界框左上角x坐标
128
128
  * @param y 边界框左上角y坐标
129
129
  * @param ex 边界框右下角x坐标
130
130
  * @param ey 边界框右下角y坐标
131
131
  * @param languages 识别语言数组,默认为["zh-Hans", "en-US"]
132
- * @returns 识别结果数组,包含文本、置信度、坐标等信息
132
+ * @param exactMatch 是否完整匹配,默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
133
+ * @returns 命中子串的识别结果数组,坐标对应目标子串区域
133
134
  * @example
134
- * const results = appleOcr.findText("screen", ["123", "456"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
135
+ * const results = appleOcr.findText("screen", ["开始"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
135
136
  * results.forEach(result => {
136
137
  * logi(`文本: ${result.text}, 置信度: ${result.confidence}`)
137
138
  * })
@@ -143,21 +144,23 @@ declare namespace appleOcr {
143
144
  y?: number,
144
145
  ex?: number,
145
146
  ey?: number,
146
- languages?: string[]
147
+ languages?: string[],
148
+ exactMatch?: boolean
147
149
  ): OCRResult[];
148
150
 
149
151
  /**
150
- * 查找指定文本,并将结果坐标映射为原图/全屏绝对坐标。
152
+ * 查找指定子串,并将子串结果坐标映射为原图/全屏绝对坐标。
151
153
  * @param input 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
152
- * @param texts 要查找的文本数组
154
+ * @param texts 要查找的目标文本数组,可匹配识别结果中的子串
153
155
  * @param x 边界框左上角x坐标
154
156
  * @param y 边界框左上角y坐标
155
157
  * @param ex 边界框右下角x坐标
156
158
  * @param ey 边界框右下角y坐标
157
159
  * @param languages 识别语言数组,默认为["zh-Hans", "en-US"]
158
- * @returns 识别结果数组,坐标为原图/全屏绝对坐标
160
+ * @param exactMatch 是否完整匹配,默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
161
+ * @returns 命中子串的识别结果数组,坐标为原图/全屏绝对坐标
159
162
  * @example
160
- * const results = appleOcr.findTextAbs("screen", ["确定"], 100, 100, 500, 400)
163
+ * const results = appleOcr.findTextAbs("screen", ["开始"], 100, 100, 500, 400)
161
164
  * if (results.length > 0) {
162
165
  * action.click(results[0].centerX, results[0].centerY)
163
166
  * }
@@ -169,6 +172,7 @@ declare namespace appleOcr {
169
172
  y?: number,
170
173
  ex?: number,
171
174
  ey?: number,
172
- languages?: string[]
175
+ languages?: string[],
176
+ exactMatch?: boolean
173
177
  ): OCRResult[];
174
178
  }
package/types/global.d.ts CHANGED
@@ -6,6 +6,10 @@ declare const __runMode__: "agent" | "hid";
6
6
  * 是否是调试模式
7
7
  */
8
8
  declare const __debug__: boolean;
9
+ /**
10
+ * 当前脚本是否在运行
11
+ */
12
+ declare const __isRunning__: boolean;
9
13
  /**
10
14
  * 平台标识
11
15
  */
@@ -99,6 +99,7 @@ declare namespace paddleOcr {
99
99
  * @param ex 裁剪区域右下角 x 坐标,全屏传 0,默认 0
100
100
  * @param ey 裁剪区域右下角 y 坐标,全屏传 0,默认 0
101
101
  * @param confidenceThreshold 置信度阈值,默认 0.6
102
+ * @param exactMatch 是否完整匹配,默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
102
103
  * @returns 匹配到的子串结果数组,坐标相对于裁剪区域
103
104
  * @example
104
105
  * const results = paddleOcr.findText("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -114,6 +115,7 @@ declare namespace paddleOcr {
114
115
  ex?: number,
115
116
  ey?: number,
116
117
  confidenceThreshold?: number,
118
+ exactMatch?: boolean,
117
119
  ): OCRResult[];
118
120
  /**
119
121
  * 查找目标文本并返回对应子串的原图/全屏绝对坐标
@@ -124,6 +126,7 @@ declare namespace paddleOcr {
124
126
  * @param ex 裁剪区域右下角 x 坐标,全屏传 0,默认 0
125
127
  * @param ey 裁剪区域右下角 y 坐标,全屏传 0,默认 0
126
128
  * @param confidenceThreshold 置信度阈值,默认 0.6
129
+ * @param exactMatch 是否完整匹配,默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
127
130
  * @returns 匹配到的子串结果数组,坐标为原图/全屏绝对坐标
128
131
  * @example
129
132
  * const results = paddleOcr.findTextAbs("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -139,6 +142,7 @@ declare namespace paddleOcr {
139
142
  ex?: number,
140
143
  ey?: number,
141
144
  confidenceThreshold?: number,
145
+ exactMatch?: boolean,
142
146
  ): OCRResult[];
143
147
  /**
144
148
  * 释放OCR模型资源
@@ -100,6 +100,7 @@ declare namespace $PaddleOCR {
100
100
  * @param 图片边界框右下角x坐标 裁剪区域右下角 x,全屏传 0,默认 0
101
101
  * @param 图片边界框右下角y坐标 裁剪区域右下角 y,全屏传 0,默认 0
102
102
  * @param 置信度阈值 置信度阈值,默认 0.6
103
+ * @param 是否完整匹配 默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
103
104
  * @returns 匹配到的子串结果数组,坐标相对于裁剪区域
104
105
  * @example
105
106
  * const 结果 = $PaddleOCR.查找文本("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -115,6 +116,7 @@ declare namespace $PaddleOCR {
115
116
  图片边界框右下角x坐标?: 数字,
116
117
  图片边界框右下角y坐标?: 数字,
117
118
  置信度阈值?: 数字,
119
+ 是否完整匹配?: 布尔值,
118
120
  ): 数组<OCR识别结果>;
119
121
  /**
120
122
  * 查找目标文本并返回对应子串的原图/全屏绝对坐标
@@ -125,6 +127,7 @@ declare namespace $PaddleOCR {
125
127
  * @param 图片边界框右下角x坐标 裁剪区域右下角 x,全屏传 0,默认 0
126
128
  * @param 图片边界框右下角y坐标 裁剪区域右下角 y,全屏传 0,默认 0
127
129
  * @param 置信度阈值 置信度阈值,默认 0.6
130
+ * @param 是否完整匹配 默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
128
131
  * @returns 匹配到的子串结果数组,坐标为原图/全屏绝对坐标
129
132
  * @example
130
133
  * const 结果 = $PaddleOCR.查找文本绝对坐标("screen", ["确定"], 100, 100, 500, 300, 0.6)
@@ -140,6 +143,7 @@ declare namespace $PaddleOCR {
140
143
  图片边界框右下角x坐标?: 数字,
141
144
  图片边界框右下角y坐标?: 数字,
142
145
  置信度阈值?: 数字,
146
+ 是否完整匹配?: 布尔值,
143
147
  ): 数组<OCR识别结果>;
144
148
  /**
145
149
  * 释放OCR模型资源
@@ -15,6 +15,10 @@ declare const $运行模式: "agent" | "hid";
15
15
  * 是否是调试模式
16
16
  */
17
17
  declare const $是否调试: 布尔值;
18
+ /**
19
+ * 当前脚本是否在运行
20
+ */
21
+ declare const $是否运行: 布尔值;
18
22
  /**
19
23
  * 平台标识
20
24
  */
@@ -123,17 +123,18 @@ declare namespace $苹果OCR {
123
123
  ): 数组<OCR识别结果>;
124
124
 
125
125
  /**
126
- * 执行OCR识别(查找指定文本)
126
+ * 执行OCR识别,在整段识别文本中查找指定子串
127
127
  * @param 输入源 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
128
- * @param 要查找的文本数组 要查找的文本数组
128
+ * @param 要查找的文本数组 要查找的目标文本数组,可匹配识别结果中的子串
129
129
  * @param 图片边界框左上角x坐标 默认 0
130
130
  * @param 图片边界框左上角y坐标 默认 0
131
131
  * @param 图片边界框右下角x坐标 默认 0
132
132
  * @param 图片边界框右下角y坐标 默认 0
133
133
  * @param 识别语言数组 识别语言数组,默认为["zh-Hans", "en-US"]
134
- * @returns 识别结果数组,包含文本、置信度、坐标等信息
134
+ * @param 是否完整匹配 默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
135
+ * @returns 命中子串的识别结果数组,坐标对应目标子串区域
135
136
  * @example
136
- * const 检查结果数组 = $苹果OCR.查找文本("screen", ["123", "456"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
137
+ * const 检查结果数组 = $苹果OCR.查找文本("screen", ["开始"], 0, 0, 100, 100, ["zh-Hans", "en-US"])
137
138
  * 检查结果数组.forEach(目标 => {
138
139
  * $打印信息日志(`文本: ${目标.text}, 置信度: ${目标.confidence}`)
139
140
  * })
@@ -145,21 +146,23 @@ declare namespace $苹果OCR {
145
146
  图片边界框左上角y坐标?: 数字,
146
147
  图片边界框右下角x坐标?: 数字,
147
148
  图片边界框右下角y坐标?: 数字,
148
- 识别语言数组?: 数组<字符串>
149
+ 识别语言数组?: 数组<字符串>,
150
+ 是否完整匹配?: 布尔值
149
151
  ): 数组<OCR识别结果>;
150
152
 
151
153
  /**
152
- * 查找指定文本,并将结果坐标映射为原图/全屏绝对坐标。
154
+ * 查找指定子串,并将子串结果坐标映射为原图/全屏绝对坐标。
153
155
  * @param 输入源 输入源(imageId、URL字符串、文件路径或"screen","screen"表示使用当前屏幕)
154
- * @param 要查找的文本数组 要查找的文本数组
156
+ * @param 要查找的文本数组 要查找的目标文本数组,可匹配识别结果中的子串
155
157
  * @param 图片边界框左上角x坐标 默认 0
156
158
  * @param 图片边界框左上角y坐标 默认 0
157
159
  * @param 图片边界框右下角x坐标 默认 0
158
160
  * @param 图片边界框右下角y坐标 默认 0
159
161
  * @param 识别语言数组 识别语言数组,默认为["zh-Hans", "en-US"]
160
- * @returns 识别结果数组,坐标为原图/全屏绝对坐标
162
+ * @param 是否完整匹配 默认 false 表示包含匹配;传 true 时要求整条 OCR 识别结果文本等于目标文本
163
+ * @returns 命中子串的识别结果数组,坐标为原图/全屏绝对坐标
161
164
  * @example
162
- * const 检查结果数组 = $苹果OCR.查找文本绝对坐标("screen", ["确定"], 100, 100, 500, 400)
165
+ * const 检查结果数组 = $苹果OCR.查找文本绝对坐标("screen", ["开始"], 100, 100, 500, 400)
163
166
  * if (检查结果数组.length > 0) {
164
167
  * $点击(检查结果数组[0].centerX, 检查结果数组[0].centerY)
165
168
  * }
@@ -171,6 +174,7 @@ declare namespace $苹果OCR {
171
174
  图片边界框左上角y坐标?: 数字,
172
175
  图片边界框右下角x坐标?: 数字,
173
176
  图片边界框右下角y坐标?: 数字,
174
- 识别语言数组?: 数组<字符串>
177
+ 识别语言数组?: 数组<字符串>,
178
+ 是否完整匹配?: 布尔值
175
179
  ): 数组<OCR识别结果>;
176
180
  }