Module: Google::Cloud::VisionAI

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

Constant Summary collapse

VERSION = 
"1.0.2"

Class Method Summary collapse

Class Method Details

.app_platform(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for AppPlatform.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the AppPlatform service. You can determine whether the method will succeed by calling app_platform_available?.

About AppPlatform

Service describing handlers for resources

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/google/cloud/vision_ai.rb', line 146

def self.app_platform version: :v1, transport: :grpc, &block
  require "google/cloud/vision_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::VisionAI.const_get(package_name).const_get(:AppPlatform)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.app_platform_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the AppPlatform service is supported by the current client. If true, you can retrieve a client object by calling app_platform. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the AppPlatform service, or if the versioned client gem needs an update to support the AppPlatform service.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/google/cloud/vision_ai.rb', line 170

def self.app_platform_available? version: :v1, transport: :grpc
  require "google/cloud/vision_ai/#{version.to_s.downcase}"
  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::VisionAI.const_get package_name
  return false unless service_module.const_defined? :AppPlatform
  service_module = service_module.const_get :AppPlatform
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

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

Configure the google-cloud-vision_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 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



501
502
503
504
505
 
# File 'lib/google/cloud/vision_ai.rb', line 501

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

  ::Google::Cloud.configure.vision_ai
end

.health_check_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for HealthCheckService.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the HealthCheckService service. You can determine whether the method will succeed by calling health_check_service_available?.

About HealthCheckService

HealthCheckService provides an interface for Vertex AI Vision Cluster Health Check.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/google/cloud/vision_ai.rb', line 430

def self.health_check_service version: :v1, transport: :grpc, &block
  require "google/cloud/vision_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::VisionAI.const_get(package_name).const_get(:HealthCheckService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.health_check_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the HealthCheckService service is supported by the current client. If true, you can retrieve a client object by calling health_check_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the HealthCheckService service, or if the versioned client gem needs an update to support the HealthCheckService service.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/google/cloud/vision_ai.rb', line 454

def self.health_check_service_available? version: :v1, transport: :grpc
  require "google/cloud/vision_ai/#{version.to_s.downcase}"
  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::VisionAI.const_get package_name
  return false unless service_module.const_defined? :HealthCheckService
  service_module = service_module.const_get :HealthCheckService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.live_video_analytics(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for LiveVideoAnalytics.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the LiveVideoAnalytics service. You can determine whether the method will succeed by calling live_video_analytics_available?.

About LiveVideoAnalytics

Service describing handlers for resources. The service enables clients to run Live Video Analytics (LVA) on the streaming inputs.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/google/cloud/vision_ai.rb', line 76

def self.live_video_analytics version: :v1, transport: :grpc, &block
  require "google/cloud/vision_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::VisionAI.const_get(package_name).const_get(:LiveVideoAnalytics)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.live_video_analytics_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the LiveVideoAnalytics service is supported by the current client. If true, you can retrieve a client object by calling live_video_analytics. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the LiveVideoAnalytics service, or if the versioned client gem needs an update to support the LiveVideoAnalytics service.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/google/cloud/vision_ai.rb', line 100

def self.live_video_analytics_available? version: :v1, transport: :grpc
  require "google/cloud/vision_ai/#{version.to_s.downcase}"
  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::VisionAI.const_get package_name
  return false unless service_module.const_defined? :LiveVideoAnalytics
  service_module = service_module.const_get :LiveVideoAnalytics
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.streaming_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for StreamingService.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the StreamingService service. You can determine whether the method will succeed by calling streaming_service_available?.

About StreamingService

Streaming service for receiving and sending packets.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/google/cloud/vision_ai.rb', line 216

def self.streaming_service version: :v1, transport: :grpc, &block
  require "google/cloud/vision_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::VisionAI.const_get(package_name).const_get(:StreamingService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.streaming_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the StreamingService service is supported by the current client. If true, you can retrieve a client object by calling streaming_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the StreamingService service, or if the versioned client gem needs an update to support the StreamingService service.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/google/cloud/vision_ai.rb', line 240

def self.streaming_service_available? version: :v1, transport: :grpc
  require "google/cloud/vision_ai/#{version.to_s.downcase}"
  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::VisionAI.const_get package_name
  return false unless service_module.const_defined? :StreamingService
  service_module = service_module.const_get :StreamingService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.streams_service(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for StreamsService.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the StreamsService service. You can determine whether the method will succeed by calling streams_service_available?.

About StreamsService

Service describing handlers for resources. Vision API and Vision AI API are two independent APIs developed by the same team. Vision API is for people to annotate their image while Vision AI is an e2e solution for customer to build their own computer vision application.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/google/cloud/vision_ai.rb', line 289

def self.streams_service version: :v1, transport: :grpc, &block
  require "google/cloud/vision_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::VisionAI.const_get(package_name).const_get(:StreamsService)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.streams_service_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the StreamsService service is supported by the current client. If true, you can retrieve a client object by calling streams_service. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the StreamsService service, or if the versioned client gem needs an update to support the StreamsService service.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/google/cloud/vision_ai.rb', line 313

def self.streams_service_available? version: :v1, transport: :grpc
  require "google/cloud/vision_ai/#{version.to_s.downcase}"
  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::VisionAI.const_get package_name
  return false unless service_module.const_defined? :StreamsService
  service_module = service_module.const_get :StreamsService
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end

.warehouse(version: :v1, transport: :grpc, &block) ⇒ ::Object

Create a new client object for Warehouse.

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

Raises an exception if the currently installed versioned client gem for the given API version does not support the given transport of the Warehouse service. You can determine whether the method will succeed by calling warehouse_available?.

About Warehouse

Service that manages media content + metadata for streaming.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (::Object) —

    A client object for the specified version.



359
360
361
362
363
364
365
366
367
368
369
 
# File 'lib/google/cloud/vision_ai.rb', line 359

def self.warehouse version: :v1, transport: :grpc, &block
  require "google/cloud/vision_ai/#{version.to_s.downcase}"

  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  service_module = Google::Cloud::VisionAI.const_get(package_name).const_get(:Warehouse)
  service_module = service_module.const_get(:Rest) if transport == :rest
  service_module.const_get(:Client).new(&block)
end

.warehouse_available?(version: :v1, transport: :grpc) ⇒ boolean

Determines whether the Warehouse service is supported by the current client. If true, you can retrieve a client object by calling warehouse. If false, that method will raise an exception. This could happen if the given API version does not exist or does not support the Warehouse service, or if the versioned client gem needs an update to support the Warehouse service.

Parameters:

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

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

  • transport (:grpc, :rest) (defaults to: :grpc) —

    The transport to use. Defaults to :grpc.

Returns:

  • (boolean) —

    Whether the service is available.



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/google/cloud/vision_ai.rb', line 383

def self.warehouse_available? version: :v1, transport: :grpc
  require "google/cloud/vision_ai/#{version.to_s.downcase}"
  package_name = Google::Cloud::VisionAI
                 .constants
                 .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                 .first
  return false unless package_name
  service_module = Google::Cloud::VisionAI.const_get package_name
  return false unless service_module.const_defined? :Warehouse
  service_module = service_module.const_get :Warehouse
  if transport == :rest
    return false unless service_module.const_defined? :Rest
    service_module = service_module.const_get :Rest
  end
  service_module.const_defined? :Client
rescue ::LoadError
  false
end