Disabled non-text output formats by default per #916 (#983)

Balearica · web-flow · commit 241cddb29c1c · 2024-12-24T01:20:54.000-08:00
diff --git a/benchmarks/node/memory-benchmark.js b/benchmarks/node/memory-benchmark.js
@@ -50,7 +50,7 @@ const workerGen = async () => {
       const promises = [];
       for (let j = 0; j < 10; j++) {
         // Results are purposefully not saved as this would increase memory usage over time.
-        promises.push(scheduler.addJob('recognize', file).then(() => (true)));
+        promises.push(scheduler.addJob('recognize', file, {}, { blocks: true }).then(() => (true)));
       }
       // eslint-disable-next-line no-await-in-loop
       await Promise.all(promises);
diff --git a/docs/api.md b/docs/api.md
@@ -82,7 +82,8 @@ Figures out what words are in `image`, where the words are in `image`, etc.
 - `image` see [Image Format](./image-format.md) for more details.
 - `options` an object of customized options
   - `rectangle` an object to specify the regions you want to recognized in the image, should contain top, left, width and height, see example below.
-- `output` an object specifying which output formats to return (by default `text`, `blocks`, `hocr`, and `tsv` are returned)
+- `output` an object specifying which output formats to return (by default only `text` is returned)
+   - Other options include `blocks` (json), `hocr`, and `tsv`
 - `jobId` Please see details above
 
 **Output:**
diff --git a/src/createWorker.js b/src/createWorker.js
@@ -165,7 +165,7 @@ module.exports = async (langs = 'eng', oem = OEM.LSTM_ONLY, _options = {}, confi
   );
 
   const recognize = async (image, opts = {}, output = {
-    blocks: true, text: true, hocr: true, tsv: true,
+    text: true,
   }, jobId) => (
     startJob(createJob({
       id: jobId,
diff --git a/src/worker-script/constants/defaultOutput.js b/src/worker-script/constants/defaultOutput.js
@@ -4,10 +4,10 @@
 
 module.exports = {
   text: true,
-  blocks: true,
+  blocks: false,
   layoutBlocks: false,
-  hocr: true,
-  tsv: true,
+  hocr: false,
+  tsv: false,
   box: false,
   unlv: false,
   osd: false,

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ const workerGen = async () => {`
`50`	`50`	`const promises = [];`
`51`	`51`	`for (let j = 0; j < 10; j++) {`
`52`	`52`	`// Results are purposefully not saved as this would increase memory usage over time.`
`53`		`- promises.push(scheduler.addJob('recognize', file).then(() => (true)));`
	`53`	`+ promises.push(scheduler.addJob('recognize', file, {}, { blocks: true }).then(() => (true)));`
`54`	`54`	`}`
`55`	`55`	`// eslint-disable-next-line no-await-in-loop`
`56`	`56`	`await Promise.all(promises);`