Vision AI API - Module Google::Cloud::VisionAI (v0.2.0)

Reference documentation and code samples for the Vision AI API module Google::Cloud::VisionAI.

Methods

.app_platform

def self.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 VisionAI.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.

.app_platform_available?

def self.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 VisionAI.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.

.configure

def self.configure() -> ::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
  • (::Google::Cloud.configure.vision_ai)
Returns
  • (::Google::Cloud::Config) — The default configuration used by this library

.health_check_service

def self.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 VisionAI.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.

.health_check_service_available?

def self.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 VisionAI.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.

.live_video_analytics

def self.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 VisionAI.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.

.live_video_analytics_available?

def self.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 VisionAI.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.

.streaming_service

def self.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 VisionAI.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.

.streaming_service_available?

def self.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 VisionAI.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.

.streams_service

def self.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 VisionAI.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.

.streams_service_available?

def self.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 VisionAI.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.

.warehouse

def self.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 VisionAI.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.

.warehouse_available?

def self.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 VisionAI.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.

Constants

VERSION

value: "0.2.0"