google-cloud-document_ai-v1beta3 0.46.0 → 0.46.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7805cd1662f5cf7f3c206528f08dd7ee710d9e8617bebf990035353ec5ffa0ba
-  data.tar.gz: 571f43e93b479e21c56536ba2b92f34fefc8833345e8d6d6d058e2159166629c
+  metadata.gz: c1a368de39f48df24cfad831efe2fd53c49fd46de6052ab83339b9c0363a204d
+  data.tar.gz: '08b5d37dd299be3be1f0acd08ef01df9454ed8118f1309da867b6d5ddf40c9c1'
 SHA512:
-  metadata.gz: 34da96dfd10ac0d2fe7aff850682d99dfe02efb1e98498d61f7de154a4ec86d0f0ce12c7fa1e0b4beff8472fc7e732308537081ee9dff1633b6ce400a146e92b
-  data.tar.gz: d319096d44b88bb26845b1b8bc07b69742a22910b1f14c55b4bad459835c7b5eaa41f417f3de4d09a89a419a3208ae64e21cab8bd4ca1e3893bfe2a3c5334219
+  metadata.gz: dd81c63357caa3dc10a7dab67573cb385870e4fcb23130a49982e8de8036645ac6dec380e4fc56e8596981a32cb24183b7dfdf4449f6d5c529e1b4f172930388
+  data.tar.gz: 2f43ba1614f6026f28855a09fc04000890a40be73a04cb9bad0ad8531396779cec710dc66bd6a57368de1ef40451efe33655950e5605e54a40b08e94204a61dd

data/lib/google/cloud/document_ai/v1beta3/document_processor_service/client.rb

@@ -2549,8 +2549,6 @@ module Google
             #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
-            #    *  (`String`) The path to a service account key file in JSON format
-            #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
             #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -2559,7 +2557,26 @@ module Google
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
             #
-            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+            #     is deprecated. Providing an unvalidated credential configuration to
+            #     Google APIs can compromise the security of your systems and data.
+            #
+            #   @example
+            #
+            #     # The recommended way to provide credentials is to use the `make_creds` method
+            #     # on the appropriate credentials class for your environment.
+            #
+            #     require "googleauth"
+            #
+            #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+            #       json_key_io: ::File.open("/path/to/keyfile.json")
+            #     )
+            #
+            #     client = ::Google::Cloud::DocumentAI::V1beta3::DocumentProcessorService::Client.new do |config|
+            #       config.credentials = credentials
+            #     end
+            #
+            #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
             #   external source for authentication to Google Cloud, you must validate it before
             #   providing it to a Google API client library. Providing an unvalidated credential
             #   configuration to Google APIs can compromise the security of your systems and data.

data/lib/google/cloud/document_ai/v1beta3/document_processor_service/operations.rb

@@ -642,8 +642,6 @@ module Google
             #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
-            #    *  (`String`) The path to a service account key file in JSON format
-            #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
             #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
             #
-            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+            #     is deprecated. Providing an unvalidated credential configuration to
+            #     Google APIs can compromise the security of your systems and data.
+            #
+            #   @example
+            #
+            #     # The recommended way to provide credentials is to use the `make_creds` method
+            #     # on the appropriate credentials class for your environment.
+            #
+            #     require "googleauth"
+            #
+            #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+            #       json_key_io: ::File.open("/path/to/keyfile.json")
+            #     )
+            #
+            #     client = ::Google::Longrunning::Operations::Client.new do |config|
+            #       config.credentials = credentials
+            #     end
+            #
+            #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
             #   external source for authentication to Google Cloud, you must validate it before
             #   providing it to a Google API client library. Providing an unvalidated credential
             #   configuration to Google APIs can compromise the security of your systems and data.

data/lib/google/cloud/document_ai/v1beta3/document_service/client.rb

@@ -962,8 +962,6 @@ module Google
             #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
-            #    *  (`String`) The path to a service account key file in JSON format
-            #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
             #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -972,7 +970,26 @@ module Google
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
             #
-            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+            #     is deprecated. Providing an unvalidated credential configuration to
+            #     Google APIs can compromise the security of your systems and data.
+            #
+            #   @example
+            #
+            #     # The recommended way to provide credentials is to use the `make_creds` method
+            #     # on the appropriate credentials class for your environment.
+            #
+            #     require "googleauth"
+            #
+            #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+            #       json_key_io: ::File.open("/path/to/keyfile.json")
+            #     )
+            #
+            #     client = ::Google::Cloud::DocumentAI::V1beta3::DocumentService::Client.new do |config|
+            #       config.credentials = credentials
+            #     end
+            #
+            #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
             #   external source for authentication to Google Cloud, you must validate it before
             #   providing it to a Google API client library. Providing an unvalidated credential
             #   configuration to Google APIs can compromise the security of your systems and data.

data/lib/google/cloud/document_ai/v1beta3/document_service/operations.rb

@@ -642,8 +642,6 @@ module Google
             #   @return [::String,nil]
             # @!attribute [rw] credentials
             #   Credentials to send with calls. You may provide any of the following types:
-            #    *  (`String`) The path to a service account key file in JSON format
-            #    *  (`Hash`) A service account key as a Hash
             #    *  (`Google::Auth::Credentials`) A googleauth credentials object
             #       (see the [googleauth docs](https://rubydoc.info/gems/googleauth/Google/Auth/Credentials))
             #    *  (`Signet::OAuth2::Client`) A signet oauth2 client object
@@ -652,7 +650,26 @@ module Google
             #    *  (`GRPC::Core::ChannelCredentials`) a gRPC credentails object
             #    *  (`nil`) indicating no credentials
             #
-            #   Warning: If you accept a credential configuration (JSON file or Hash) from an
+            #   @note Warning: Passing a `String` to a keyfile path or a `Hash` of credentials
+            #     is deprecated. Providing an unvalidated credential configuration to
+            #     Google APIs can compromise the security of your systems and data.
+            #
+            #   @example
+            #
+            #     # The recommended way to provide credentials is to use the `make_creds` method
+            #     # on the appropriate credentials class for your environment.
+            #
+            #     require "googleauth"
+            #
+            #     credentials = ::Google::Auth::ServiceAccountCredentials.make_creds(
+            #       json_key_io: ::File.open("/path/to/keyfile.json")
+            #     )
+            #
+            #     client = ::Google::Longrunning::Operations::Client.new do |config|
+            #       config.credentials = credentials
+            #     end
+            #
+            #   @note Warning: If you accept a credential configuration (JSON file or Hash) from an
             #   external source for authentication to Google Cloud, you must validate it before
             #   providing it to a Google API client library. Providing an unvalidated credential
             #   configuration to Google APIs can compromise the security of your systems and data.

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

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module DocumentAI
       module V1beta3
-        VERSION = "0.46.0"
+        VERSION = "0.46.2"
       end
     end
   end

data/proto_docs/google/cloud/documentai/v1beta3/document.rb

@@ -93,8 +93,9 @@ module Google
         # @!attribute [rw] blob_assets
         #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::BlobAsset>]
         #     Optional. The blob assets in this document. This is used to store the
-        #     content of the inline blobs in this document, e.g. image bytes, such that
-        #     it can be referenced by other fields in the document via asset id.
+        #     content of the inline blobs in this document, for example, image bytes,
+        #     such that it can be referenced by other fields in the document via asset
+        #     id.
         # @!attribute [rw] entity_validation_output
         #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::EntityValidationOutput]
         #     The entity validation output for the document. This is the validation
@@ -106,10 +107,10 @@ module Google
         #     entity extraction results at different stages of the processing.
         # @!attribute [rw] entities_revision_id
         #   @return [::String]
-        #     The entity revision id that `document.entities` field is based on.
+        #     The entity revision ID that `document.entities` field is based on.
         #     If this field is set and `entities_revisions` is not empty, the entities in
         #     `document.entities` field are the entities in the entity revision with this
-        #     id and `document.entity_validation_output` field is the
+        #     ID and `document.entity_validation_output` field is the
         #     `entity_validation_output` field in this entity revision.
         class Document
           include ::Google::Protobuf::MessageExts
@@ -231,7 +232,7 @@ module Google
           #     A list of visually detected tokens on the page.
           # @!attribute [rw] visual_elements
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::VisualElement>]
-          #     A list of detected non-text visual elements e.g. checkbox,
+          #     A list of detected non-text visual elements for example, checkbox,
           #     signature etc. on the page.
           # @!attribute [rw] tables
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Page::Table>]
@@ -322,9 +323,9 @@ module Google
             #   @return [::Float]
             #     Confidence of the current
             #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} within
-            #     context of the object this layout is for. e.g. confidence can be for a
-            #     single token, a table, a visual element, etc. depending on context.
-            #     Range `[0, 1]`.
+            #     context of the object this layout is for. For example, confidence can
+            #     be for a single token, a table, a visual element, etc. depending on
+            #     context. Range `[0, 1]`.
             # @!attribute [rw] bounding_poly
             #   @return [::Google::Cloud::DocumentAI::V1beta3::BoundingPoly]
             #     The bounding polygon for the
@@ -530,8 +531,8 @@ module Google
               extend ::Google::Protobuf::MessageExts::ClassMethods
             end
 
-            # Detected non-text visual elements e.g. checkbox, signature etc. on the
-            # page.
+            # Detected non-text visual elements, for example, checkbox, signature, etc.
+            # on the page.
             # @!attribute [rw] layout
             #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
             #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for
@@ -604,7 +605,8 @@ module Google
             #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
             #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
             #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::FormField FormField}
-            #     name. e.g. `Address`, `Email`, `Grand total`, `Phone number`, etc.
+            #     name. For example, `Address`, `Email`, `Grand total`, `Phone number`,
+            #     etc.
             # @!attribute [rw] field_value
             #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout]
             #     {::Google::Cloud::DocumentAI::V1beta3::Document::Page::Layout Layout} for the
@@ -715,10 +717,10 @@ module Google
           #     {::Google::Cloud::DocumentAI::V1beta3::Document#text Document.text}.
           # @!attribute [rw] type
           #   @return [::String]
-          #     Required. Entity type from a schema e.g. `Address`.
+          #     Required. Entity type from a schema for example, `Address`.
           # @!attribute [rw] mention_text
           #   @return [::String]
-          #     Optional. Text value of the entity e.g. `1600 Amphitheatre Pkwy`.
+          #     Optional. Text value of the entity for example, `1600 Amphitheatre Pkwy`.
           # @!attribute [rw] mention_id
           #   @return [::String]
           #     Optional. Deprecated.  Use `id` field instead.
@@ -731,14 +733,14 @@ module Google
           #     the page where it was found.
           # @!attribute [rw] id
           #   @return [::String]
-          #     Optional. Canonical id. This will be a unique value in the entity list
+          #     Optional. Canonical ID. This will be a unique value in the entity list
           #     for this document.
           # @!attribute [rw] normalized_value
           #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::Entity::NormalizedValue]
           #     Optional. Normalized entity value. Absent if the extracted value could
-          #     not be converted or the type (e.g. address) is not supported for certain
-          #     parsers. This field is also only populated for certain supported document
-          #     types.
+          #     not be converted or the type (for example, address) is not supported for
+          #     certain parsers. This field is also only populated for certain supported
+          #     document types.
           # @!attribute [rw] properties
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
           #     Optional. Entities can be nested to form a hierarchical data structure
@@ -841,10 +843,10 @@ module Google
           # {::Google::Cloud::DocumentAI::V1beta3::Document::Entity Entities}.
           # @!attribute [rw] subject_id
           #   @return [::String]
-          #     Subject entity id.
+          #     Subject entity ID.
           # @!attribute [rw] object_id
           #   @return [::String]
-          #     Object entity id.
+          #     Object entity ID.
           # @!attribute [rw] relation
           #   @return [::String]
           #     Relationship description.
@@ -984,7 +986,7 @@ module Google
           # @!attribute [rw] id
           #   @deprecated This field is deprecated and may be removed in the next major version update.
           #   @return [::Integer]
-          #     The Id of this operation.  Needs to be unique within the scope of the
+          #     The ID of this operation.  Needs to be unique within the scope of the
           #     revision.
           # @!attribute [rw] parents
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Provenance::Parent>]
@@ -1008,7 +1010,7 @@ module Google
             # @!attribute [rw] id
             #   @deprecated This field is deprecated and may be removed in the next major version update.
             #   @return [::Integer]
-            #     The id of the parent provenance.
+            #     The ID of the parent provenance.
             class Parent
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -1051,7 +1053,7 @@ module Google
           # Contains past or forward revisions of this document.
           # @!attribute [rw] agent
           #   @return [::String]
-          #     If the change was made by a person specify the name or id of that
+          #     If the change was made by a person specify the name or ID of that
           #     person.
           #
           #     Note: The following fields are mutually exclusive: `agent`, `processor`. If a field in that set is populated, all other fields in the set will automatically be cleared.
@@ -1063,7 +1065,7 @@ module Google
           #     Note: The following fields are mutually exclusive: `processor`, `agent`. If a field in that set is populated, all other fields in the set will automatically be cleared.
           # @!attribute [rw] id
           #   @return [::String]
-          #     Id of the revision, internally generated by doc proto storage.
+          #     ID of the revision, internally generated by doc proto storage.
           #     Unique within the context of the document.
           # @!attribute [rw] parent
           #   @deprecated This field is deprecated and may be removed in the next major version update.
@@ -1073,7 +1075,7 @@ module Google
           #     index into the `revisions` field.
           # @!attribute [rw] parent_ids
           #   @return [::Array<::String>]
-          #     The revisions that this revision is based on. Must include all the ids
+          #     The revisions that this revision is based on. Must include all the IDs
           #     that have anything to do with this revision - eg. there are
           #     `provenance.parent.revision` fields that index into this field.
           # @!attribute [rw] create_time
@@ -1090,7 +1092,7 @@ module Google
             # Human Review information of the document.
             # @!attribute [rw] state
             #   @return [::String]
-            #     Human review state. e.g. `requested`, `succeeded`, `rejected`.
+            #     Human review state. For example, `requested`, `succeeded`, `rejected`.
             # @!attribute [rw] state_message
             #   @return [::String]
             #     A message providing more details about the current state of processing.
@@ -1277,22 +1279,22 @@ module Google
               # Represents an image type block.
               # @!attribute [rw] blob_asset_id
               #   @return [::String]
-              #     Optional. Asset id of the inline image. If set, find the image
+              #     Optional. Asset ID of the inline image. If set, find the image
               #     content in the blob_assets field.
               #
               #     Note: The following fields are mutually exclusive: `blob_asset_id`, `gcs_uri`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] gcs_uri
               #   @return [::String]
-              #     Optional. Google Cloud Storage uri of the image.
+              #     Optional. Google Cloud Storage URI of the image.
               #
               #     Note: The following fields are mutually exclusive: `gcs_uri`, `blob_asset_id`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] data_uri
               #   @return [::String]
-              #     Optional. Data uri of the image.
+              #     Optional. Data URI of the image.
               #     It is composed of four parts: a prefix (data:), a MIME type
               #     indicating the type of data, an optional base64 token if
               #     non-textual, and the data itself:
-              #     data:[<mediatype>][;base64],<data>
+              #     data:[<mediatype>][;base64],<data>.
               #
               #     Note: The following fields are mutually exclusive: `data_uri`, `blob_asset_id`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] mime_type
@@ -1386,22 +1388,22 @@ module Google
               # The image chunk field in the chunk.
               # @!attribute [rw] blob_asset_id
               #   @return [::String]
-              #     Optional. Asset id of the inline image. If set, find the image
+              #     Optional. Asset ID of the inline image. If set, find the image
               #     content in the blob_assets field.
               #
               #     Note: The following fields are mutually exclusive: `blob_asset_id`, `gcs_uri`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] gcs_uri
               #   @return [::String]
-              #     Optional. Google Cloud Storage uri of the image.
+              #     Optional. Google Cloud Storage URI of the image.
               #
               #     Note: The following fields are mutually exclusive: `gcs_uri`, `blob_asset_id`, `data_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] data_uri
               #   @return [::String]
-              #     Optional. Data uri of the image.
+              #     Optional. Data URI of the image.
               #     It is composed of four parts: a prefix (data:), a MIME type
               #     indicating the type of data, an optional base64 token if
               #     non-textual, and the data itself:
-              #     data:[<mediatype>][;base64],<data>
+              #     data:[<mediatype>][;base64],<data>.
               #
               #     Note: The following fields are mutually exclusive: `data_uri`, `blob_asset_id`, `gcs_uri`. If a field in that set is populated, all other fields in the set will automatically be cleared.
               # @!attribute [rw] annotations
@@ -1422,7 +1424,7 @@ module Google
               end
 
               # The chunk field in the chunk. A chunk field could be one of the various
-              # types (e.g. image, table) supported.
+              # types (for example, image, table) supported.
               # @!attribute [rw] image_chunk_field
               #   @return [::Google::Cloud::DocumentAI::V1beta3::Document::ChunkedDocument::Chunk::ImageChunkField]
               #     The image chunk field in the chunk.
@@ -1441,14 +1443,14 @@ module Google
           end
 
           # Represents a blob asset. It's used to store the content of the inline blob
-          # in this document, e.g. image bytes, such that it can be referenced by
-          # other fields in the document via asset id.
+          # in this document, for example, image bytes, such that it can be referenced
+          # by other fields in the document via asset ID.
           # @!attribute [rw] asset_id
           #   @return [::String]
-          #     Optional. The id of the blob asset.
+          #     Optional. The ID of the blob asset.
           # @!attribute [rw] content
           #   @return [::String]
-          #     Optional. The content of the blob asset, e.g. image bytes.
+          #     Optional. The content of the blob asset, for example, image bytes.
           # @!attribute [rw] mime_type
           #   @return [::String]
           #     The mime type of the blob asset.
@@ -1512,7 +1514,7 @@ module Google
           # Entity revision.
           # @!attribute [rw] revision_id
           #   @return [::String]
-          #     The revision id.
+          #     The revision ID.
           # @!attribute [rw] entities
           #   @return [::Array<::Google::Cloud::DocumentAI::V1beta3::Document::Entity>]
           #     The entities in this revision.
@@ -1533,7 +1535,7 @@ module Google
         #     Note: The following fields are mutually exclusive: `revision_case`, `revision_id`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] revision_id
         #   @return [::String]
-        #     Reads the revision given by the id.
+        #     Reads the revision given by the ID.
         #
         #     Note: The following fields are mutually exclusive: `revision_id`, `revision_case`, `latest_processor_version`. If a field in that set is populated, all other fields in the set will automatically be cleared.
         # @!attribute [rw] latest_processor_version

data/proto_docs/google/cloud/documentai/v1beta3/document_processor_service.rb

@@ -95,12 +95,14 @@ module Google
             # @!attribute [rw] semantic_chunking_group_size
             #   @return [::Boolean]
             #     Optional. The number of tokens to group together when evaluating
-            #     semantic similarity. THIS FIELD IS NOT YET USED.
+            #     semantic similarity.
+            #     **Note:** This field is not yet used.
             # @!attribute [rw] breakpoint_percentile_threshold
             #   @return [::Integer]
             #     Optional. The percentile of cosine dissimilarity that must be exceeded
             #     between a group of tokens and the next. The smaller this number is, the
-            #     more chunks will be generated. THIS FIELD IS NOT YET USED.
+            #     more chunks will be generated.
+            #     **Note:** This field is not yet used.
             class ChunkingConfig
               include ::Google::Protobuf::MessageExts
               extend ::Google::Protobuf::MessageExts::ClassMethods

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-document_ai-v1beta3
 version: !ruby/object:Gem::Version
-  version: 0.46.0
+  version: 0.46.2
 platform: ruby
 authors:
 - Google LLC