google-cloud-document_ai 0.1.1 → 0.1.2

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: a96d228658fe35872dd01ae61135191edfda283e35b5a1740a7fff4ecb61ff58
4
- data.tar.gz: d9d527d137e680920db853c49290d4ff57b080d548d0f831906942678dff13d1
3
+ metadata.gz: a36c8529ea52cc041c6b282fd4f26156350f28a66f0f574eb3411761c06a84c1
4
+ data.tar.gz: 144c8ff13d959bf113670359a87ccb35375b0b16d36fbed13031bd96e76a93fb
5
5
  SHA512:
6
- metadata.gz: 3caf2cba1297c24354486a1d001e4d31806387909f0172c6fd8e84600deb13c1fe7d6f3b21e99ec41c6eec383dcca4534dccb128e89e42caea03801db1b782ff
7
- data.tar.gz: 717513a6ffce05cb17de1317b888409ad6af6473ef71330d8e5696ae7b91f6cdac15bb2e8a45dc75ee00966bdd73ec0ff43386f257a183ba03c33049afeb118b
6
+ metadata.gz: 103f090160feda3144a791beb7b4775ace609786a0d32b637e94cb7b54e0a9ef8af5ab49b825251a580eed05ffd83b283f79b632e0c38a8202a74f32c99f32d1
7
+ data.tar.gz: 671fcaa71810293c0d457cc20caa28a99eb6e487dfedcb045e4e6b095537f5a19f290c8b6492580a243083e0355e8dc21c29e807adca88c12068553aea8ce16f
data/README.md CHANGED
@@ -6,9 +6,10 @@ Document AI uses machine learning on a single cloud-based platform to automatica
6
6
 
7
7
  Actual client classes for the various versions of this API are defined in
8
8
  _versioned_ client gems, with names of the form `google-cloud-document_ai-v*`.
9
- The gem `google-cloud-document_ai` is a convenience wrapper library that brings the
9
+ The gem `google-cloud-document_ai` is the main client library that brings the
10
10
  verisoned gems in as dependencies, and provides high-level methods for
11
- constructing clients.
11
+ constructing clients. More information on versioned clients can be found below
12
+ in the section titled *Which client should I use?*.
12
13
 
13
14
  View the [Client Library Documentation](https://googleapis.dev/ruby/google-cloud-document_ai/latest)
14
15
  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
69
70
  and later. Older versions of Ruby _may_ still work, but are unsupported and not
70
71
  recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
71
72
  about the Ruby support schedule.
73
+
74
+ ## Which client should I use?
75
+
76
+ Most modern Ruby client libraries for Google APIs come in two flavors: the main
77
+ client library with a name such as `google-cloud-document_ai`,
78
+ and lower-level _versioned_ client libraries with names such as
79
+ `google-cloud-document_ai-v1beta3`.
80
+ _In most cases, you should install the main client._
81
+
82
+ ### What's the difference between the main client and a versioned client?
83
+
84
+ A _versioned client_ provides a basic set of data types and client classes for
85
+ a _single version_ of a specific service. (That is, for a service with multiple
86
+ versions, there might be a separate versioned client for each service version.)
87
+ Most versioned clients are written and maintained by a code generator.
88
+
89
+ The _main client_ is designed to provide you with the _recommended_ client
90
+ interfaces for the service. There will be only one main client for any given
91
+ service, even a service with multiple versions. The main client includes
92
+ factory methods for constructing the client objects we recommend for most
93
+ users. In some cases, those will be classes provided by an underlying versioned
94
+ client; in other cases, they will be handwritten higher-level client objects
95
+ with additional capabilities, convenience methods, or best practices built in.
96
+ Generally, the main client will default to a recommended service version,
97
+ although in some cases you can override this if you need to talk to a specific
98
+ service version.
99
+
100
+ ### Why would I want to use the main client?
101
+
102
+ We recommend that most users install the main client gem for a service. You can
103
+ identify this gem as the one _without_ a version in its name, e.g.
104
+ `google-cloud-document_ai`.
105
+ The main client is recommended because it will embody the best practices for
106
+ accessing the service, and may also provide more convenient interfaces or
107
+ tighter integration into frameworks and third-party libraries. In addition, the
108
+ documentation and samples published by Google will generally demonstrate use of
109
+ the main client.
110
+
111
+ ### Why would I want to use a versioned client?
112
+
113
+ You can use a versioned client if you are content with a possibly lower-level
114
+ class interface, you explicitly want to avoid features provided by the main
115
+ client, or you want to access a specific service version not be covered by the
116
+ main client. You can identify versioned client gems because the service version
117
+ is part of the name, e.g. `google-cloud-document_ai-v1beta3`.
118
+
119
+ ### What about the google-apis-<name> clients?
120
+
121
+ Client library gems with names that begin with `google-apis-` are based on an
122
+ older code generation technology. They talk to a REST/JSON backend (whereas
123
+ most modern clients talk to a [gRPC](https://grpc.io/) backend) and they may
124
+ not offer the same performance, features, and ease of use provided by more
125
+ modern clients.
126
+
127
+ The `google-apis-` clients have wide coverage across Google services, so you
128
+ might need to use one if there is no modern client available for the service.
129
+ However, if a modern client is available, we generally recommend it over the
130
+ older `google-apis-` clients.
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module DocumentAI
23
- VERSION = "0.1.1"
23
+ VERSION = "0.1.2"
24
24
  end
25
25
  end
26
26
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-document_ai
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.1.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2021-01-20 00:00:00.000000000 Z
11
+ date: 2021-02-02 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-cloud-core