google-cloud-document_ai 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a96d228658fe35872dd01ae61135191edfda283e35b5a1740a7fff4ecb61ff58
-  data.tar.gz: d9d527d137e680920db853c49290d4ff57b080d548d0f831906942678dff13d1
+  metadata.gz: a36c8529ea52cc041c6b282fd4f26156350f28a66f0f574eb3411761c06a84c1
+  data.tar.gz: 144c8ff13d959bf113670359a87ccb35375b0b16d36fbed13031bd96e76a93fb
 SHA512:
-  metadata.gz: 3caf2cba1297c24354486a1d001e4d31806387909f0172c6fd8e84600deb13c1fe7d6f3b21e99ec41c6eec383dcca4534dccb128e89e42caea03801db1b782ff
-  data.tar.gz: 717513a6ffce05cb17de1317b888409ad6af6473ef71330d8e5696ae7b91f6cdac15bb2e8a45dc75ee00966bdd73ec0ff43386f257a183ba03c33049afeb118b
+  metadata.gz: 103f090160feda3144a791beb7b4775ace609786a0d32b637e94cb7b54e0a9ef8af5ab49b825251a580eed05ffd83b283f79b632e0c38a8202a74f32c99f32d1
+  data.tar.gz: 671fcaa71810293c0d457cc20caa28a99eb6e487dfedcb045e4e6b095537f5a19f290c8b6492580a243083e0355e8dc21c29e807adca88c12068553aea8ce16f

data/README.md

@@ -6,9 +6,10 @@ Document AI uses machine learning on a single cloud-based platform to automatica
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-document_ai-v*`.
-The gem `google-cloud-document_ai` is a convenience wrapper library that brings the
+The gem `google-cloud-document_ai` is the main client library that brings the
 verisoned gems in as dependencies, and provides high-level methods for
-constructing clients.
+constructing clients. More information on versioned clients can be found below
+in the section titled *Which client should I use?*.
 
 View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-document_ai/latest)
 for this library, google-cloud-document_ai, to see the convenience methods for
@@ -69,3 +70,61 @@ in security maintenance, and not end of life. Currently, this means Ruby 2.4
 and later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
+
+## Which client should I use?
+
+Most modern Ruby client libraries for Google APIs come in two flavors: the main
+client library with a name such as `google-cloud-document_ai`,
+and lower-level _versioned_ client libraries with names such as
+`google-cloud-document_ai-v1beta3`.
+_In most cases, you should install the main client._
+
+### What's the difference between the main client and a versioned client?
+
+A _versioned client_ provides a basic set of data types and client classes for
+a _single version_ of a specific service. (That is, for a service with multiple
+versions, there might be a separate versioned client for each service version.)
+Most versioned clients are written and maintained by a code generator.
+
+The _main client_ is designed to provide you with the _recommended_ client
+interfaces for the service. There will be only one main client for any given
+service, even a service with multiple versions. The main client includes
+factory methods for constructing the client objects we recommend for most
+users. In some cases, those will be classes provided by an underlying versioned
+client; in other cases, they will be handwritten higher-level client objects
+with additional capabilities, convenience methods, or best practices built in.
+Generally, the main client will default to a recommended service version,
+although in some cases you can override this if you need to talk to a specific
+service version.
+
+### Why would I want to use the main client?
+
+We recommend that most users install the main client gem for a service. You can
+identify this gem as the one _without_ a version in its name, e.g.
+`google-cloud-document_ai`.
+The main client is recommended because it will embody the best practices for
+accessing the service, and may also provide more convenient interfaces or
+tighter integration into frameworks and third-party libraries. In addition, the
+documentation and samples published by Google will generally demonstrate use of
+the main client.
+
+### Why would I want to use a versioned client?
+
+You can use a versioned client if you are content with a possibly lower-level
+class interface, you explicitly want to avoid features provided by the main
+client, or you want to access a specific service version not be covered by the
+main client. You can identify versioned client gems because the service version
+is part of the name, e.g. `google-cloud-document_ai-v1beta3`.
+
+### What about the google-apis-<name> clients?
+
+Client library gems with names that begin with `google-apis-` are based on an
+older code generation technology. They talk to a REST/JSON backend (whereas
+most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
+not offer the same performance, features, and ease of use provided by more
+modern clients.
+
+The `google-apis-` clients have wide coverage across Google services, so you
+might need to use one if there is no modern client available for the service.
+However, if a modern client is available, we generally recommend it over the
+older `google-apis-` clients.

data/lib/google/cloud/document_ai/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module DocumentAI
-      VERSION = "0.1.1"
+      VERSION = "0.1.2"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2021-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core