Class: Google::Cloud::Vision::V1::ImageAnnotatorClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/vision/v1/image_annotator_client.rb

Overview

Service that performs Google Cloud Vision API detection tasks over client images, such as face, landmark, logo, label, and text detection. The ImageAnnotator service returns detected entities from the images.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"vision.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT = 
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform"
].freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ ImageAnnotatorClient

Returns a new instance of ImageAnnotatorClient

Parameters:

  • service_path (String) —

    The domain name of the API remote host.

  • port (Integer) —

    The port on which to connect to the remote host.

  • channel (Channel) —

    A Channel object through which to make calls.

  • chan_creds (Grpc::ChannelCredentials) —

    A ChannelCredentials for the setting up the RPC client.

  • client_config (Hash) —

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric) —

    The default timeout, in seconds, for calls made through this client.



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/google/cloud/vision/v1/image_annotator_client.rb', line 73

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    app_name: nil,
    app_version: nil,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/cloud/vision/v1/image_annotator_services_pb"


  if app_name || app_version
    warn "`app_name` and `app_version` are no longer being used in the request headers."
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "image_annotator_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.cloud.vision.v1.ImageAnnotator",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @image_annotator_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    scopes: scopes,
    &Google::Cloud::Vision::V1::ImageAnnotator::Stub.method(:new)
  )

  @batch_annotate_images = Google::Gax.create_api_call(
    @image_annotator_stub.method(:batch_annotate_images),
    defaults["batch_annotate_images"]
  )
end

Instance Attribute Details

#image_annotator_stub ⇒ Google::Cloud::Vision::V1::ImageAnnotator::Stub (readonly)

Returns:



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/google/cloud/vision/v1/image_annotator_client.rb', line 41

class ImageAnnotatorClient
  attr_reader :image_annotator_stub

  # The default address of the service.
  SERVICE_ADDRESS = "vision.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform"
  ].freeze

  # @param service_path [String]
  #   The domain name of the API remote host.
  # @param port [Integer]
  #   The port on which to connect to the remote host.
  # @param channel [Channel]
  #   A Channel object through which to make calls.
  # @param chan_creds [Grpc::ChannelCredentials]
  #   A ChannelCredentials for the setting up the RPC client.
  # @param client_config[Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      app_name: nil,
      app_version: nil,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/cloud/vision/v1/image_annotator_services_pb"


    if app_name || app_version
      warn "`app_name` and `app_version` are no longer being used in the request headers."
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "image_annotator_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.cloud.vision.v1.ImageAnnotator",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @image_annotator_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      scopes: scopes,
      &Google::Cloud::Vision::V1::ImageAnnotator::Stub.method(:new)
    )

    @batch_annotate_images = Google::Gax.create_api_call(
      @image_annotator_stub.method(:batch_annotate_images),
      defaults["batch_annotate_images"]
    )
  end

  # Service calls

  # Run image detection and annotation for a batch of images.
  #
  # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest>]
  #   Individual image annotation requests for this batch.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Cloud::Vision::V1::BatchAnnotateImagesResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/vision/v1/image_annotator_client"
  #
  #   ImageAnnotatorClient = Google::Cloud::Vision::V1::ImageAnnotatorClient
  #
  #   image_annotator_client = ImageAnnotatorClient.new
  #   requests = []
  #   response = image_annotator_client.batch_annotate_images(requests)

  def batch_annotate_images \
      requests,
      options: nil
    req = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new({
      requests: requests
    }.delete_if { |_, v| v.nil? })
    @batch_annotate_images.call(req, options)
  end
end

Instance Method Details

#batch_annotate_images(requests, options: nil) ⇒ Google::Cloud::Vision::V1::BatchAnnotateImagesResponse

Run image detection and annotation for a batch of images.

Examples:

require "google/cloud/vision/v1/image_annotator_client"

ImageAnnotatorClient = Google::Cloud::Vision::V1::ImageAnnotatorClient

image_annotator_client = ImageAnnotatorClient.new
requests = []
response = image_annotator_client.batch_annotate_images(requests)

Parameters:

  • requests (Array<Google::Cloud::Vision::V1::AnnotateImageRequest>) —

    Individual image annotation requests for this batch.

  • options (Google::Gax::CallOptions) —

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError) —

    if the RPC is aborted.



152
153
154
155
156
157
158
159
 
# File 'lib/google/cloud/vision/v1/image_annotator_client.rb', line 152

def batch_annotate_images \
    requests,
    options: nil
  req = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new({
    requests: requests
  }.delete_if { |_, v| v.nil? })
  @batch_annotate_images.call(req, options)
end