Module: Google::Cloud::DocumentAI

Defined in:
lib/google/cloud/document_ai.rb,
lib/google/cloud/document_ai/version.rb

Constant Summary collapse

VERSION = 
"1.0.0"

Class Method Summary collapse

Class Method Details

.configure {|::Google::Cloud.configure.document_ai| ... } ⇒ ::Google::Cloud::Config

Configure the google-cloud-document_ai library.

The following configuration parameters are supported:

  • credentials (type: String, Hash, Google::Auth::Credentials) - The path to the keyfile as a String, the contents of the keyfile as a Hash, or a Google::Auth::Credentials object.
  • lib_name (type: String) - The library name as recorded in instrumentation and logging.
  • lib_version (type: String) - The library version as recorded in instrumentation and logging.
  • interceptors (type: Array<GRPC::ClientInterceptor>) - An array of interceptors that are run before calls are executed.
  • timeout (type: Numeric) - Default timeout in seconds.
  • metadata (type: Hash{Symbol=>String}) - Additional gRPC headers to be sent with the call.
  • retry_policy (type: Hash) - The retry policy. The value is a hash with the following keys:
    • :initial_delay (type: Numeric) - The initial delay in seconds.
    • :max_delay (type: Numeric) - The max delay in seconds.
    • :multiplier (type: Numeric) - The incremental backoff multiplier.
    • :retry_codes (type: Array<String>) - The error codes that should trigger a retry.

Yields:

Returns:

  • (::Google::Cloud::Config) —

    The default configuration used by this library



108
109
110
111
112
 
# File 'lib/google/cloud/document_ai.rb', line 108

def self.configure
  yield ::Google::Cloud.configure.document_ai if block_given?

  ::Google::Cloud.configure.document_ai
end

.document_processor_service(version: :v1, &block) ⇒ DocumentProcessorService::Client

Create a new client object for DocumentProcessorService.

By default, this returns an instance of Google::Cloud::DocumentAI::V1::DocumentProcessorService::Client for version V1 of the API. However, you can specify specify a different API version by passing it in the version parameter. If the DocumentProcessorService service is supported by that API version, and the corresponding gem is available, the appropriate versioned client will be returned.

About DocumentProcessorService

Service to call Cloud DocumentAI to process documents according to the processor's definition. Processors are built using state-of-the-art Google AI such as natural language, computer vision, and translation to extract structured information from unstructured or semi-structured documents.

Parameters:

  • version (::String, ::Symbol) (defaults to: :v1) —

    The API version to connect to. Optional. Defaults to :v1.

Returns:

  • (DocumentProcessorService::Client) —

    A client object for the specified version.



69
70
71
72
73
74
75
76
77
78
 
# File 'lib/google/cloud/document_ai.rb', line 69

def self.document_processor_service version: :v1, &block
  require "google/cloud/document_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::DocumentAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  package_module = Google::Cloud::DocumentAI.const_get package_name
  package_module.const_get(:DocumentProcessorService).const_get(:Client).new(&block)
end