fix(documentai): make quickstart functional (#9108)

Author: coryan

ci/etc/integration-tests-config.ps1

@@ -69,6 +69,11 @@ $env:GOOGLE_CLOUD_CPP_PUBSUB_TEST_QUICKSTART_TOPIC="quickstart"
 # Cloud BigQuery configuration parameters
 $env:GOOGLE_CLOUD_CPP_BIGQUERY_TEST_QUICKSTART_TABLE="projects/bigquery-public-data/datasets/usa_names/tables/usa_1910_current"
 
+# Document AI
+$env:GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_LOCATION_ID="us"
+$env:GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_PROCESSOR_ID="3cb572567f9df97f"
+$env:GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_FILENAME="${env:PROJECT_ROOT}/google/cloud/documentai/quickstart/resources/invoice.pdf"
+
 # Cloud IAM configuration parameters
 $env:GOOGLE_CLOUD_CPP_IAM_CREDENTIALS_TEST_SERVICE_ACCOUNT="iam-credentials-test-sa@${env:GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com"
 $env:GOOGLE_CLOUD_CPP_IAM_TEST_SERVICE_ACCOUNT="iam-test-sa@${env:GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com"

ci/etc/integration-tests-config.sh

@@ -85,6 +85,11 @@ export GOOGLE_CLOUD_CPP_PUBSUB_TEST_QUICKSTART_TOPIC="quickstart"
 # Cloud BigQuery configuration parameters
 export GOOGLE_CLOUD_CPP_BIGQUERY_TEST_QUICKSTART_TABLE="projects/bigquery-public-data/datasets/usa_names/tables/usa_1910_current"
 
+# Document AI
+export GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_LOCATION_ID="us"
+export GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_PROCESSOR_ID="3cb572567f9df97f"
+export GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_FILENAME="${PROJECT_ROOT}/google/cloud/documentai/quickstart/resources/invoice.pdf"
+
 # Cloud IAM configuration parameters
 export GOOGLE_CLOUD_CPP_IAM_CREDENTIALS_TEST_SERVICE_ACCOUNT="iam-credentials-test-sa@${GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com"
 export GOOGLE_CLOUD_CPP_IAM_TEST_SERVICE_ACCOUNT="iam-test-sa@${GOOGLE_CLOUD_PROJECT}.iam.gserviceaccount.com"

google/cloud/documentai/CMakeLists.txt

@@ -114,11 +114,11 @@ if (BUILD_TESTING)
         COMMAND
             cmake -P "${PROJECT_SOURCE_DIR}/cmake/quickstart-runner.cmake"
             $<TARGET_FILE:documentai_quickstart> GOOGLE_CLOUD_PROJECT
-            # TODO(#7976): Enable this quickstart and make it run.
-    )
-    set_tests_properties(
-        documentai_quickstart PROPERTIES DISABLED true LABELS
-                                         "integration-test;quickstart")
+            GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_LOCATION_ID
+            GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_PROCESSOR_ID
+            GOOGLE_CLOUD_CPP_DOCUMENTAI_TEST_FILENAME)
+    set_tests_properties(documentai_quickstart
+                         PROPERTIES LABELS "integration-test;quickstart")
 endif ()
 
 # Get the destination directories based on the GNU recommendations.

google/cloud/documentai/README.md

@@ -1,14 +1,10 @@
 # Cloud Document AI API C++ Client Library
 
-:warning: This library will not be declared GA until the quickstart is operable.
-
 This directory contains an idiomatic C++ client library for the
 [Cloud Document AI API][cloud-service], a service that uses machine
 learning on a scalable cloud-based platform to help your organization
 efficiently scan, analyze, and understand documents.
 
-This library is **experimental**. Its APIs are subject to change without notice.
-
 While this library is **GA**, please note that the Google Cloud C++ client libraries do **not** follow
 [Semantic Versioning](https://semver.org/).
 
@@ -43,13 +39,14 @@ this library.
 ```cc
 #include "google/cloud/documentai/document_processor_client.h"
 #include "google/cloud/common_options.h"
+#include <fstream>
 #include <iostream>
 #include <stdexcept>
 
 int main(int argc, char* argv[]) try {
-  if (argc != 4) {
+  if (argc != 5) {
     std::cerr << "Usage: " << argv[0]
-              << " project-id location-id processor-id\n";
+              << " project-id location-id processor-id filename (PDF only)\n";
     return 1;
   }
   std::string const location = argv[2];
@@ -59,11 +56,11 @@ int main(int argc, char* argv[]) try {
   }
 
   namespace gc = ::google::cloud;
+  namespace documentai = ::google::cloud::documentai;
+  // The Document AI service requires using an endpoint matching the processor's
+  // location.
   auto options = gc::Options{}.set<gc::EndpointOption>(
       location + "-documentai.googleapis.com");
-  options.set<google::cloud::TracingComponentsOption>({"rpc"});
-
-  namespace documentai = ::google::cloud::documentai;
   auto client = documentai::DocumentProcessorServiceClient(
       documentai::MakeDocumentProcessorServiceConnection(options));
 
@@ -73,9 +70,10 @@ int main(int argc, char* argv[]) try {
   google::cloud::documentai::v1::ProcessRequest req;
   req.set_name(resource);
   req.set_skip_human_review(true);
-  auto& doc = *req.mutable_inline_document();
+  auto& doc = *req.mutable_raw_document();
   doc.set_mime_type("application/pdf");
-  doc.set_uri("gs://cloud-samples-data/documentai/invoice.pdf");
+  std::ifstream is(argv[4]);
+  doc.set_content(std::string{std::istreambuf_iterator<char>(is), {}});
 
   auto resp = client.ProcessDocument(std::move(req));
   if (!resp) throw std::runtime_error(resp.status().message());

google/cloud/documentai/quickstart/README.md

@@ -1,7 +1,5 @@
 # HOWTO: using the Cloud Document AI API C++ client in your project
 
-:warning: This quickstart is not yet operable.
-
 This directory contains small examples showing how to use the Cloud Document AI API C++
 client library in your own project. These instructions assume that you have
 some experience as a C++ developer and that you have a working C++ toolchain

google/cloud/documentai/quickstart/quickstart.cc

@@ -14,13 +14,14 @@
 
 #include "google/cloud/documentai/document_processor_client.h"
 #include "google/cloud/common_options.h"
+#include <fstream>
 #include <iostream>
 #include <stdexcept>
 
 int main(int argc, char* argv[]) try {
-  if (argc != 4) {
+  if (argc != 5) {
     std::cerr << "Usage: " << argv[0]
-              << " project-id location-id processor-id\n";
+              << " project-id location-id processor-id filename (PDF only)\n";
     return 1;
   }
   std::string const location = argv[2];
@@ -30,11 +31,11 @@ int main(int argc, char* argv[]) try {
   }
 
   namespace gc = ::google::cloud;
+  namespace documentai = ::google::cloud::documentai;
+  // The Document AI service requires using an endpoint matching the processor's
+  // location.
   auto options = gc::Options{}.set<gc::EndpointOption>(
       location + "-documentai.googleapis.com");
-  options.set<google::cloud::TracingComponentsOption>({"rpc"});
-
-  namespace documentai = ::google::cloud::documentai;
   auto client = documentai::DocumentProcessorServiceClient(
       documentai::MakeDocumentProcessorServiceConnection(options));
 
@@ -44,9 +45,10 @@ int main(int argc, char* argv[]) try {
   google::cloud::documentai::v1::ProcessRequest req;
   req.set_name(resource);
   req.set_skip_human_review(true);
-  auto& doc = *req.mutable_inline_document();
+  auto& doc = *req.mutable_raw_document();
   doc.set_mime_type("application/pdf");
-  doc.set_uri("gs://cloud-samples-data/documentai/invoice.pdf");
+  std::ifstream is(argv[4]);
+  doc.set_content(std::string{std::istreambuf_iterator<char>(is), {}});
 
   auto resp = client.ProcessDocument(std::move(req));
   if (!resp) throw std::runtime_error(resp.status().message());