Vision PDF/OCR (GoogleCloudPlatform#622)

Author: sirtorry

vision/README.md

@@ -39,6 +39,7 @@ Vision API from PHP.
   text           Detect text in an image using Google Cloud Vision API
   crop-hints     Detect crop hints in an image using Google Cloud Vision API
   document-text  Detect document text in an image using Google Cloud Vision API
+  pdf            Detect text in a PDF/TIFF using Google Cloud Vision API
   web            Detect web entities in an image using Google Cloud Vision API
   web-geo        Detect web entities in an image with geo metadata using
                  Google Cloud Vision API

vision/composer.json

@@ -2,7 +2,7 @@
     "name": "google/vision",
     "type": "project",
     "require": {
-        "google/cloud-vision": "^0.10",
+        "google/cloud-vision": "^0.13",
         "google/cloud-storage": "^1.3",
         "symfony/console": "^3.1"
     },
@@ -32,7 +32,8 @@
             "src/detect_web.php",
             "src/detect_web_gcs.php",
             "src/detect_web_with_geo_metadata.php",
-            "src/detect_web_with_geo_metadata_gcs.php"
+            "src/detect_web_with_geo_metadata_gcs.php",
+            "src/detect_pdf_gcs.php"
         ]
     },
     "require-dev": {

vision/composer.lock

@@ -47,5 +47,7 @@ function detect_crop_hints($path)
     } else {
         print('No crop hints' . PHP_EOL);
     }
+    
+    $imageAnnotator->close();
 }
 // [END vision_crop_hint_detection]

vision/src/detect_crop_hints.php

@@ -46,5 +46,7 @@ function detect_crop_hints_gcs($path)
     } else {
         print('No crop hints' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_crop_hint_detection_gcs]

vision/src/detect_crop_hints_gcs.php

@@ -63,5 +63,7 @@ function detect_document_text($path)
     } else {
         print('No text found' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_fulltext_detection]

vision/src/detect_document_text.php

@@ -63,5 +63,7 @@ function detect_document_text_gcs($path)
     } else {
         print('No text found' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_fulltext_detection_gcs]

vision/src/detect_document_text_gcs.php

@@ -103,6 +103,8 @@ function detect_face($path, $outFile = null)
         printf('Output image written to %s' . PHP_EOL, $outFile);
         # [END vision_face_detection_tutorial_run_application]
     }
+
+    $imageAnnotator->close();
     // [START vision_face_detection]
 }
 // [END vision_face_detection]

vision/src/detect_face.php

@@ -54,5 +54,7 @@ function detect_face_gcs($path)
         print('Bounds: ' . join(', ',$bounds) . PHP_EOL);
         print(PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_face_detection_gcs]

vision/src/detect_face_gcs.php

@@ -40,5 +40,7 @@ function detect_image_property($path)
         printf("Blue: %s" . PHP_EOL, $color->getBlue());
         print(PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_image_property_detection]

vision/src/detect_image_property.php

@@ -44,5 +44,7 @@ function detect_image_property_gcs($path)
     } else {
         print('No Results.' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_image_property_detection_gcs]

vision/src/detect_image_property_gcs.php

@@ -39,5 +39,7 @@ function detect_label($path)
     } else {
         print('No label found' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_label_detection]

vision/src/detect_label.php

@@ -38,5 +38,7 @@ function detect_label_gcs($path)
     } else {
         print('No label found' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_label_detection_gcs]

vision/src/detect_label_gcs.php

@@ -35,5 +35,7 @@ function detect_landmark($path)
     foreach ($landmarks as $landmark) {
         print($landmark->getDescription() . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_landmark_detection]

vision/src/detect_landmark.php

@@ -34,5 +34,7 @@ function detect_landmark_gcs($path)
     foreach ($landmarks as $landmark) {
         print($landmark->getDescription() . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_landmark_detection_gcs]

vision/src/detect_landmark_gcs.php

@@ -35,5 +35,7 @@ function detect_logo($path)
     foreach ($logos as $logo) {
         print($logo->getDescription() . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_logo_detection]

vision/src/detect_logo.php

@@ -34,5 +34,7 @@ function detect_logo_gcs($path)
     foreach ($logos as $logo) {
         print($logo->getDescription() . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_logo_detection_gcs]

vision/src/detect_logo_gcs.php

@@ -0,0 +1,107 @@
+
+/**
+ * Copyright 2018 Google Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// [START vision_text_detection_pdf_gcs]
+namespace Google\Cloud\Samples\Vision;
+
+use Google\Cloud\Storage\StorageClient;
+use Google\Cloud\Vision\V1\AnnotateFileResponse;
+use Google\Cloud\Vision\V1\AsyncAnnotateFileRequest;
+use Google\Cloud\Vision\V1\Feature;
+use Google\Cloud\Vision\V1\Feature_Type;
+use Google\Cloud\Vision\V1\GcsDestination;
+use Google\Cloud\Vision\V1\GcsSource;
+use Google\Cloud\Vision\V1\ImageAnnotatorClient;
+use Google\Cloud\Vision\V1\InputConfig;
+use Google\Cloud\Vision\V1\OutputConfig;
+
+// $path = 'gs://path/to/your/document.pdf'
+
+function detect_pdf_gcs($path, $output)
+{
+    # select ocr feature
+    $feature = (new Feature())
+        ->setType(Feature_Type::DOCUMENT_TEXT_DETECTION);
+
+    # set $path (file to OCR) as source
+    $gcsSource = (new GcsSource())
+        ->setUri($path);
+    # supported mime_types are: 'application/pdf' and 'image/tiff'
+    $mimeType = 'application/pdf';
+    $inputConfig = (new InputConfig())
+        ->setGcsSource($gcsSource)
+        ->setMimeType($mimeType);
+
+    # set $output as destination
+    $gcsDestination = (new GcsDestination())
+        ->setUri($output);
+    # how many pages should be grouped into each json output file.
+    $batchSize = 2;
+    $outputConfig = (new OutputConfig())
+        ->setGcsDestination($gcsDestination)
+        ->setBatchSize($batchSize);
+
+    # prepare request using configs set above
+    $request = (new AsyncAnnotateFileRequest())
+        ->setFeatures([$feature])
+        ->setInputConfig($inputConfig)
+        ->setOutputConfig($outputConfig);
+    $requests = [$request];
+
+    # make request
+    $imageAnnotator = new ImageAnnotatorClient();
+    $operation = $imageAnnotator->asyncBatchAnnotateFiles($requests);
+    print('Waiting for operation to finish.' . PHP_EOL);
+    $operation->pollUntilComplete();
+
+    # once the request has completed and the output has been
+    # written to GCS, we can list all the output files.
+    preg_match('/^gs:\/\/([a-z0-9\._\-]+)\/(\S+)$/', $output, $match);
+    $bucketName = $match[1];
+    $prefix = $match[2];
+
+    $storage = new StorageClient();
+    $bucket = $storage->bucket($bucketName);
+    $options = ['prefix' => $prefix];
+    $objects = $bucket->objects($options);
+
+    # save first object for sample below
+    $objects->next();
+    $firstObject = $objects->current();
+
+    # list objects with the given prefix.
+    print('Output files:' . PHP_EOL);
+    foreach ($objects as $object) {
+        print($object->name() . PHP_EOL);
+    }
+
+    # process the first output file from GCS.
+    # since we specified batch_size=2, the first response contains
+    # the first two pages of the input file.
+    $jsonString = $firstObject->downloadAsString();
+    $firstBatch = new AnnotateFileResponse();
+    $firstBatch->mergeFromJsonString($jsonString);
+
+    # get annotation and print text
+    foreach ($firstBatch->getResponses() as $response) {
+        $annotation = $response->getFullTextAnnotation();
+        print($annotation->getText());
+    }
+
+    $imageAnnotator->close();
+}
+// [END vision_text_detection_pdf_gcs]

vision/src/detect_pdf_gcs.php

@@ -46,5 +46,7 @@ function detect_safe_search($path)
     printf("Spoof: %s" . PHP_EOL, $likelihoodName[$spoof]);
     printf("Violence: %s" . PHP_EOL, $likelihoodName[$violence]);
     printf("Racy: %s" . PHP_EOL, $likelihoodName[$racy]);
+
+    $imageAnnotator->close();
 }
 // [END vision_safe_search_detection]

vision/src/detect_safe_search.php

@@ -49,5 +49,7 @@ function detect_safe_search_gcs($path)
     } else {
         print('No Results.' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_safe_search_detection_gcs]

vision/src/detect_safe_search_gcs.php

@@ -43,5 +43,7 @@ function detect_text($path)
         }
         print('Bounds: ' . join(', ',$bounds) . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_text_detection]

vision/src/detect_text.php

@@ -42,5 +42,7 @@ function detect_text_gcs($path)
         }
         print('Bounds: ' . join(', ',$bounds) . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_text_detection_gcs]

vision/src/detect_text_gcs.php

@@ -79,5 +79,7 @@ function detect_web($path)
             $entity->getDescription(),
             $entity->getScore());
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_web_detection]

vision/src/detect_web.php

@@ -81,5 +81,7 @@ function detect_web_gcs($path)
     } else {
         print('No Results.' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_web_detection_gcs]

vision/src/detect_web_gcs.php

@@ -52,5 +52,7 @@ function detect_web_with_geo_metadata($path)
             print(PHP_EOL);
         }
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_web_detection_include_geo]

vision/src/detect_web_with_geo_metadata.php

@@ -53,5 +53,7 @@ function detect_web_with_geo_metadata_gcs($path)
     } else {
         print('No Results.' . PHP_EOL);
     }
+
+    $imageAnnotator->close();
 }
 // [END vision_web_detection_include_geo_gcs]

vision/src/detect_web_with_geo_metadata_gcs.php

@@ -271,6 +271,16 @@ public function testDocumentTextCommandGcs()
         $this->assertContains('Bounds:', $output);
     }
 
+    public function testPdfGcs()
+    {
+        $this->requireCloudStorage();
+
+        $source = 'gs://' . $this->bucketName . '/HodgeConj.pdf';
+        $destination = 'gs://' . $this->bucketName . '/OCR_PDF_TEST_OUTPUT/';
+        $output = $this->runCommand('pdf', $source, $destination);
+        $this->assertContains('Output files:', $output);
+    }
+
     public function testDetectWebNoGeoCommand()
     {
         $path = __DIR__ . '/data/geotagged.jpg';